SchemaConstants

All Known Implementing Classes:: adminPersonaCustom, eventCustom, objectEventCustom, ownerCustom, permCustom, syncChannelCustom, taskCustom

public interface SchemaConstants

This file defines known constants for pre-defined Schema object types, fields, and certain pre-defined objects that the server depends on for administering default permissions.

Fixed object types used for the server's operations

Object Name	Object Type ID	Purpose
Owner Group	0	An association between a collection of admin personae and the collection of objects they own.
Admin Persona	1	A record of privileges and owner groups that can be associated with a user.
Role	2	A record of permissions by object and field type. Associated with admin personae.
User	3	A person who can log in to Ganymede.
System Event	4	A type of general system event that can be logged and for which mail can be sent to a list of addresses when it occurs.
Task	5	A schedulable work routine.
Object Event	6	A kind of event that can occur in relation to a specific database object, which can be logged and for which mail can be sent to a list of addresses.
Sync Channel	7	Definition for a synchronous sync channel that uses message queueing logic to send change deltas to external sync targets.

Common fields present in all DBObjects

Field Name	Field ID	Field Type	Purpose
OwnerListField	0	`InvidDBField`	List of owner groups with authority over this object
ExpirationField	1	`DateDBField`	date that this object will expire
RemovalField	2	`DateDBField`	date that this object will be removed
NotesField	3	`StringDBField`	string field for notes for this object
CreationDateField	4	`DateDBField`	date that this object was created
CreatorField	5	`StringDBField`	string describing the creator of this object
ModificationDateField	6	`DateDBField`	date that this object was last modified
ModifierField	7	`StringDBField`	string describing the administrator who last modified this object

This file contains lots of other constants for fields in the 8 mandatory object types, but I'm tired of typing, so I'm not going to try to document them in the javadoc class header right now.

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`BackLinksField` any miscellaneous pointers pointing to us are kept track of in this field if we don't have an explicit back-link field.
`static short`	`ContainerField`
`static short`	`CreationDateField` date that this object was created
`static short`	`CreatorField` string describing the creator of this object
`static short`	`EventBase`
`static short`	`EventDescription` fuller description of this event class, suitable for an email body (String field)
`static short`	`EventExternalMail` A list of external email addresses to send mail for this event to.
`static short`	`EventMailBoolean` if true, events of this type should be mailed (Boolean field)
`static short`	`EventMailOwners` if true, the owner groups owning the objects referenced in this event will get a copy of any mail (Boolean field)
`static short`	`EventMailToSelf` if true, the admin performing the action will get a copy of any mail (Boolean field)
`static short`	`EventName` Short name for this event class, suitable for an email message title (String field)
`static short`	`EventToken` single-word token for this event class (String field)
`static short`	`ExpirationField` date that this object will expire
`static short`	`FinalBase` what's the last base we currently have defined as a mandatory base?
`static short`	`FinalSystemField` in case we add more system fields to objects
`static short`	`ModificationDateField` date that this object was last modified
`static short`	`ModifierField` string describing the administrator who last modified this object
`static short`	`NotesField` string field for notes for this object
`static short`	`ObjectEventBase`
`static short`	`ObjectEventDescription` fuller description of this event class, suitable for an email body (String field)
`static short`	`ObjectEventExternalMail` A list of external email addresses to send mail for this event to.
`static short`	`ObjectEventLabel` Hidden label field used for synthesizing composite label from the ObjectEventToken and ObjectEventObjectName fields.
`static short`	`ObjectEventMailOwners` if true, the owner groups owning objects affected by this event will get a copy of the mail
`static short`	`ObjectEventMailToSelf` if true, the admin performing the action will get a copy of any mail (Boolean field)
`static short`	`ObjectEventName` Short name for this event class, suitable for an email message title (String field)
`static short`	`ObjectEventObjectName` the name of the object type that this event category applies to
`static short`	`ObjectEventObjectType` the short id of the object type that this event category applies to
`static short`	`ObjectEventToken` single-word token for this event class (String field)
`static short`	`OwnerBase` all objects are owned by objects of type OwnerBase
`static short`	`OwnerCcAdmins` If true, all mail sent in care of this owner group will be distributed to all admins on the list automatically
`static short`	`OwnerExternalMail` what external email addresses should be notified if objects owned change?
`static short`	`OwnerListField` list of owner groups with authority over this object
`static short`	`OwnerMembersField` what admin:role entities have privileges in this OwnerBase?
`static short`	`OwnerNameField` name of this owner set
`static short`	`OwnerObjectsOwned` what objects does this owner set own?
`static short`	`OwnerSupergash` the following is a fixed object id's
`static short`	`PersonaAdminConsole` boolean, does this role have access to the admin console?
`static short`	`PersonaAdminPower` boolean, does this role have full access to the admin console?
`static short`	`PersonaAssocUser` if associated with a user, here's the reference.
`static short`	`PersonaBase` an administrator privilege record
`static short`	`PersonaGroupsField` list of owner groups that this admin is a member of
`static short`	`PersonaInterpreterPower` boolean, does this role have access to the administrative interpreter?
`static short`	`PersonaLabelField` string, a hidden label field.
`static short`	`PersonaMailAddr` string, the mail address for this administrator, if not implicitly extracted from their user name.
`static short`	`PersonaMonitorObj` Object number for a pre-defined object used by the server
`static short`	`PersonaNameField` what is this descriptive tag for this persona, not including the user name?
`static short`	`PersonaPasswordField` password for this admin account
`static short`	`PersonaPrivs` vector of permission invids for this admin account
`static short`	`PersonaSupergashObj` Object number for a pre-defined object used by the server
`static short`	`RemovalField` date that this object will be removed.
`static short`	`RoleBase` this base contains a set of permission bits constraining the admin personae's power
`static short`	`RoleDefaultMatrix` permissions applying to all objects not owned by the relevant personae
`static short`	`RoleDefaultObj` Object number for a pre-defined object used by the server
`static short`	`RoleDelegatable` can this role be passed on to admins created by admins owning this role?
`static short`	`RoleMatrix` permissions applying to objects owned by admin personae
`static short`	`RoleName` The name of this Role (String)
`static short`	`RolePersonae` what admin personae are using this role?
`static short`	`SyncChannelBase` Records of synchronous message queue channels for delta change transmissions.
`static short`	`SyncChannelClassName` If we're going to have a SyncMaster object injecting extra information into the delta sync records produced for this Sync Channel, we'll have a class name in this field.
`static short`	`SyncChannelDirectory` Directory to write sync records to
`static short`	`SyncChannelFields` What fields are we interested in syncing to this channel?
`static short`	`SyncChannelFullStateFile` If we're a full-state XML sync program, what file will we write to?
`static short`	`SyncChannelName` Name of this sync channel
`static short`	`SyncChannelPlaintextOK` Do we allow plaintext passwords on this channel?
`static short`	`SyncChannelServicer` External program to run to serve this sync channel.
`static short`	`SyncChannelTypeNum` Are we going to act as an incremental, full-state, or manual XML sync channel?
`static short`	`SyncChannelTypeString` Are we going to act as an incremental, full-state, or manual XML sync channel?
`static short`	`TaskBase` Records of task classes we want to attach to the server
`static short`	`TaskClass` what is the fully qualified classname for this builder task?
`static short`	`TaskName` name of this task (i.e., DNSBuilder, NISBuilder)
`static short`	`TaskOptionStrings` string: vector of option strings that can be interpreted by a given builder task
`static short`	`TaskPeriodAnchor` date: anchor point used to determine time of day, week, etc.
`static short`	`TaskPeriodCount` numeric: how many period units between task execution?
`static short`	`TaskPeriodUnit` string: what is the inteval unit for periodic execution
`static short`	`TaskRunOnCommit` boolean: should this task be scheduled for execution when a transaction is committed
`static short`	`TaskRunPeriodically` boolean: should this task be scheduled for execution at regular intevals?
`static short`	`UserAdminPersonae` pointer to zero or more associated admin personae
`static short`	`UserBase`
`static short`	`UserPassword` password
`static short`	`UserUserName` username string

- Field Detail
  - OwnerListField
```
static final short OwnerListField
```
    list of owner groups with authority over this object
    
    See Also:
    Constant Field Values
  - ExpirationField
```
static final short ExpirationField
```
    date that this object will expire
    
    See Also:
    Constant Field Values
  - RemovalField
```
static final short RemovalField
```
    date that this object will be removed.
    
    See Also:
    Constant Field Values
  - NotesField
```
static final short NotesField
```
    string field for notes for this object
    
    See Also:
    Constant Field Values
  - CreationDateField
```
static final short CreationDateField
```
    date that this object was created
    
    See Also:
    Constant Field Values
  - CreatorField
```
static final short CreatorField
```
    string describing the creator of this object
    
    See Also:
    Constant Field Values
  - ModificationDateField
```
static final short ModificationDateField
```
    date that this object was last modified
    
    See Also:
    Constant Field Values
  - ModifierField
```
static final short ModifierField
```
    string describing the administrator who last modified this object
    
    See Also:
    Constant Field Values
  - BackLinksField
```
static final short BackLinksField
```
    any miscellaneous pointers pointing to us are kept track of in this field if we don't have an explicit back-link field.
    
    This field is DEPRECATED and RESERVED, and should only be encountered in ganymede.db files from old versions of the Ganymede server.
    
    See Also:
    Constant Field Values
  - FinalSystemField
```
static final short FinalSystemField
```
    in case we add more system fields to objects
    
    See Also:
    Constant Field Values
  - ContainerField
```
static final short ContainerField
```
    See Also:
    Constant Field Values
  - OwnerBase
```
static final short OwnerBase
```
    all objects are owned by objects of type OwnerBase
    
    See Also:
    Constant Field Values
  - OwnerNameField
```
static final short OwnerNameField
```
    name of this owner set
    
    See Also:
    Constant Field Values
  - OwnerMembersField
```
static final short OwnerMembersField
```
    what admin:role entities have privileges in this OwnerBase?
    
    See Also:
    Constant Field Values
  - OwnerObjectsOwned
```
static final short OwnerObjectsOwned
```
    what objects does this owner set own?
    
    See Also:
    Constant Field Values
  - OwnerCcAdmins
```
static final short OwnerCcAdmins
```
    If true, all mail sent in care of this owner group will be distributed to all admins on the list automatically
    
    See Also:
    Constant Field Values
  - OwnerExternalMail
```
static final short OwnerExternalMail
```
    what external email addresses should be notified if objects owned change?
    
    See Also:
    Constant Field Values
  - OwnerSupergash
```
static final short OwnerSupergash
```
    the following is a fixed object id's
    
    See Also:
    Constant Field Values
  - PersonaBase
```
static final short PersonaBase
```
    an administrator privilege record
    
    See Also:
    Constant Field Values
  - PersonaNameField
```
static final short PersonaNameField
```
    what is this descriptive tag for this persona, not including the user name?
    
    See Also:
    Constant Field Values
  - PersonaPasswordField
```
static final short PersonaPasswordField
```
    password for this admin account
    
    See Also:
    Constant Field Values
  - PersonaGroupsField
```
static final short PersonaGroupsField
```
    list of owner groups that this admin is a member of
    
    See Also:
    Constant Field Values
  - PersonaAssocUser
```
static final short PersonaAssocUser
```
    if associated with a user, here's the reference.
    
    See Also:
    Constant Field Values
  - PersonaPrivs
```
static final short PersonaPrivs
```
    vector of permission invids for this admin account
    
    See Also:
    Constant Field Values
  - PersonaAdminConsole
```
static final short PersonaAdminConsole
```
    boolean, does this role have access to the admin console?
    
    See Also:
    Constant Field Values
  - PersonaAdminPower
```
static final short PersonaAdminPower
```
    boolean, does this role have *full* access to the admin console?
    
    See Also:
    Constant Field Values
  - PersonaMailAddr
```
static final short PersonaMailAddr
```
    string, the mail address for this administrator, if not implicitly extracted from their user name.
    
    See Also:
    Constant Field Values
  - PersonaLabelField
```
static final short PersonaLabelField
```
    string, a hidden label field. Not usually directly editable, derived from PersonaNameField and PersonaAssocUser.
    
    See Also:
    Constant Field Values
  - PersonaInterpreterPower
```
static final short PersonaInterpreterPower
```
    boolean, does this role have access to the administrative interpreter?
    
    See Also:
    Constant Field Values
  - PersonaSupergashObj
```
static final short PersonaSupergashObj
```
    Object number for a pre-defined object used by the server
    
    See Also:
    Constant Field Values
  - PersonaMonitorObj
```
static final short PersonaMonitorObj
```
    Object number for a pre-defined object used by the server
    
    See Also:
    Constant Field Values
  - RoleBase
```
static final short RoleBase
```
    this base contains a set of permission bits constraining the admin personae's power
    
    See Also:
    Constant Field Values
  - RoleName
```
static final short RoleName
```
    The name of this Role (String)
    
    See Also:
    Constant Field Values
  - RoleMatrix
```
static final short RoleMatrix
```
    permissions applying to objects owned by admin personae
    
    See Also:
    Constant Field Values
  - RolePersonae
```
static final short RolePersonae
```
    what admin personae are using this role?
    
    See Also:
    Constant Field Values
  - RoleDefaultMatrix
```
static final short RoleDefaultMatrix
```
    permissions applying to all objects not owned by the relevant personae
    
    See Also:
    Constant Field Values
  - RoleDelegatable
```
static final short RoleDelegatable
```
    can this role be passed on to admins created by admins owning this role?
    
    See Also:
    Constant Field Values
  - RoleDefaultObj
```
static final short RoleDefaultObj
```
    Object number for a pre-defined object used by the server
    
    See Also:
    Constant Field Values
  - UserBase
```
static final short UserBase
```
    See Also:
    Constant Field Values
  - UserUserName
```
static final short UserUserName
```
    username string
    
    See Also:
    Constant Field Values
  - UserPassword
```
static final short UserPassword
```
    password
    
    See Also:
    Constant Field Values
  - UserAdminPersonae
```
static final short UserAdminPersonae
```
    pointer to zero or more associated admin personae
    
    See Also:
    Constant Field Values
  - EventBase
```
static final short EventBase
```
    See Also:
    Constant Field Values
  - EventToken
```
static final short EventToken
```
    single-word token for this event class (String field)
    
    See Also:
    Constant Field Values
  - EventName
```
static final short EventName
```
    Short name for this event class, suitable for an email message title (String field)
    
    See Also:
    Constant Field Values
  - EventDescription
```
static final short EventDescription
```
    fuller description of this event class, suitable for an email body (String field)
    
    See Also:
    Constant Field Values
  - EventMailBoolean
```
static final short EventMailBoolean
```
    if true, events of this type should be mailed (Boolean field)
    
    See Also:
    Constant Field Values
  - EventMailToSelf
```
static final short EventMailToSelf
```
    if true, the admin performing the action will get a copy of any mail (Boolean field)
    
    See Also:
    Constant Field Values
  - EventMailOwners
```
static final short EventMailOwners
```
    if true, the owner groups owning the objects referenced in this event will get a copy of any mail (Boolean field)
    
    See Also:
    Constant Field Values
  - EventExternalMail
```
static final short EventExternalMail
```
    A list of external email addresses to send mail for this event to. That is, addresses in raw string form, rather than as an invid reference to a user or email list recorded in Ganymede. (String field)
    
    See Also:
    Constant Field Values
  - ObjectEventBase
```
static final short ObjectEventBase
```
    See Also:
    Constant Field Values
  - ObjectEventLabel
```
static final short ObjectEventLabel
```
    Hidden label field used for synthesizing composite label from the ObjectEventToken and ObjectEventObjectName fields.
    
    See Also:
    Constant Field Values
  - ObjectEventToken
```
static final short ObjectEventToken
```
    single-word token for this event class (String field)
    
    See Also:
    Constant Field Values
  - ObjectEventName
```
static final short ObjectEventName
```
    Short name for this event class, suitable for an email message title (String field)
    
    See Also:
    Constant Field Values
  - ObjectEventDescription
```
static final short ObjectEventDescription
```
    fuller description of this event class, suitable for an email body (String field)
    
    See Also:
    Constant Field Values
  - ObjectEventMailToSelf
```
static final short ObjectEventMailToSelf
```
    if true, the admin performing the action will get a copy of any mail (Boolean field)
    
    See Also:
    Constant Field Values
  - ObjectEventObjectName
```
static final short ObjectEventObjectName
```
    the name of the object type that this event category applies to
    
    See Also:
    Constant Field Values
  - ObjectEventMailOwners
```
static final short ObjectEventMailOwners
```
    if true, the owner groups owning objects affected by this event will get a copy of the mail
    
    See Also:
    Constant Field Values
  - ObjectEventObjectType
```
static final short ObjectEventObjectType
```
    the short id of the object type that this event category applies to
    
    See Also:
    Constant Field Values
  - ObjectEventExternalMail
```
static final short ObjectEventExternalMail
```
    A list of external email addresses to send mail for this event to. That is, addresses in raw string form, rather than as an invid reference to a user or email list recorded in Ganymede. (String field)
    
    See Also:
    Constant Field Values
  - TaskBase
```
static final short TaskBase
```
    Records of task classes we want to attach to the server
    
    See Also:
    Constant Field Values
  - TaskName
```
static final short TaskName
```
    name of this task (i.e., DNSBuilder, NISBuilder)
    
    See Also:
    Constant Field Values
  - TaskClass
```
static final short TaskClass
```
    what is the fully qualified classname for this builder task?
    
    See Also:
    Constant Field Values
  - TaskRunOnCommit
```
static final short TaskRunOnCommit
```
    boolean: should this task be scheduled for execution when a transaction is committed
    
    See Also:
    Constant Field Values
  - TaskRunPeriodically
```
static final short TaskRunPeriodically
```
    boolean: should this task be scheduled for execution at regular intevals?
    
    See Also:
    Constant Field Values
  - TaskPeriodUnit
```
static final short TaskPeriodUnit
```
    string: what is the inteval unit for periodic execution
    
    See Also:
    Constant Field Values
  - TaskPeriodCount
```
static final short TaskPeriodCount
```
    numeric: how many period units between task execution?
    
    See Also:
    Constant Field Values
  - TaskPeriodAnchor
```
static final short TaskPeriodAnchor
```
    date: anchor point used to determine time of day, week, etc.
    
    See Also:
    Constant Field Values
  - TaskOptionStrings
```
static final short TaskOptionStrings
```
    string: vector of option strings that can be interpreted by a given builder task
    
    See Also:
    Constant Field Values
  - SyncChannelBase
```
static final short SyncChannelBase
```
    Records of synchronous message queue channels for delta change transmissions.
    
    See Also:
    Constant Field Values
  - SyncChannelName
```
static final short SyncChannelName
```
    Name of this sync channel
    
    See Also:
    Constant Field Values
  - SyncChannelDirectory
```
static final short SyncChannelDirectory
```
    Directory to write sync records to
    
    See Also:
    Constant Field Values
  - SyncChannelServicer
```
static final short SyncChannelServicer
```
    External program to run to serve this sync channel.
    
    See Also:
    Constant Field Values
  - SyncChannelFields
```
static final short SyncChannelFields
```
    What fields are we interested in syncing to this channel?
    
    See Also:
    Constant Field Values
  - SyncChannelPlaintextOK
```
static final short SyncChannelPlaintextOK
```
    Do we allow plaintext passwords on this channel?
    
    See Also:
    Constant Field Values
  - SyncChannelTypeString
```
static final short SyncChannelTypeString
```
    Are we going to act as an incremental, full-state, or manual XML sync channel? Scalar string field, used for display and input only.. we'll actually put an integer into the SyncChannelTypeNum field instead to do the real tracking.
    
    See Also:
    Constant Field Values
  - SyncChannelFullStateFile
```
static final short SyncChannelFullStateFile
```
    If we're a full-state XML sync program, what file will we write to? The external channel servicer will take this filename as a command line argument. Scalar string field.
    
    See Also:
    Constant Field Values
  - SyncChannelTypeNum
```
static final short SyncChannelTypeNum
```
    Are we going to act as an incremental, full-state, or manual XML sync channel? Hidden integer field, used to abstract the type from whatever localization is in effect in the server.
    
    See Also:
    Constant Field Values
  - SyncChannelClassName
```
static final short SyncChannelClassName
```
    If we're going to have a SyncMaster object injecting extra information into the delta sync records produced for this Sync Channel, we'll have a class name in this field.
    
    See Also:
    Constant Field Values
  - FinalBase
```
static final short FinalBase
```
    what's the last base we currently have defined as a mandatory base?
    
    See Also:
    Constant Field Values

Interface SchemaConstants

Fixed object types used for the server's operations

Common fields present in all DBObjects

Field Summary

Field Detail

OwnerListField

ExpirationField

RemovalField

NotesField

CreationDateField

CreatorField

ModificationDateField

ModifierField

BackLinksField

FinalSystemField

ContainerField

OwnerBase

OwnerNameField

OwnerMembersField

OwnerObjectsOwned

OwnerCcAdmins

OwnerExternalMail

OwnerSupergash

PersonaBase

PersonaNameField

PersonaPasswordField

PersonaGroupsField

PersonaAssocUser

PersonaPrivs

PersonaAdminConsole

PersonaAdminPower

PersonaMailAddr

PersonaLabelField

PersonaInterpreterPower

PersonaSupergashObj

PersonaMonitorObj

RoleBase

RoleName

RoleMatrix

RolePersonae

RoleDefaultMatrix

RoleDelegatable

RoleDefaultObj

UserBase

UserUserName

UserPassword

UserAdminPersonae

EventBase

EventToken

EventName

EventDescription

EventMailBoolean

EventMailToSelf

EventMailOwners

EventExternalMail

ObjectEventBase

ObjectEventLabel

ObjectEventToken

ObjectEventName

ObjectEventDescription

ObjectEventMailToSelf

ObjectEventObjectName

ObjectEventMailOwners

ObjectEventObjectType

ObjectEventExternalMail

TaskBase

TaskName

TaskClass

TaskRunOnCommit

TaskRunPeriodically

TaskPeriodUnit

TaskPeriodCount

TaskPeriodAnchor

TaskOptionStrings

SyncChannelBase

SyncChannelName

SyncChannelDirectory

SyncChannelServicer

SyncChannelFields

SyncChannelPlaintextOK