SystemStatus

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.sandev.TaskHeap.sandmessages
Class SystemStatus

java.lang.Object
  org.sandev.TaskHeap.structs.SystemStatusStruct
      org.sandev.TaskHeap.sandmessages.SystemStatus

All Implemented Interfaces:: org.sandev.basics.structs.SandInstanceMessage, org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandPersistMessage, org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable

public class SystemStatus
extends SystemStatusStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable, org.sandev.basics.structs.SandPersistMessage
extends SystemStatusStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable, org.sandev.basics.structs.SandPersistMessage

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.structs.SystemStatusStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jul 31, 2008 4:34:16 PM

Field Summary
`static int`	`ACCESSLEVEL_NOACCESS` Possible value for accessLevel
`static int`	`ACCESSLEVEL_NORMAL` Possible value for accessLevel
`static int`	`ACCESSLEVEL_READONLY` Possible value for accessLevel
`protected java.util.Date`	`creationTime` An immutable timestamp reflecting the time when this instance first created.
`protected int`	`instanceWriteAccess` A transient field for instance modifiability for use in safe concurrent reference situations like caching.
`protected java.util.Date`	`lastAccessedTime` A transient field for tracking object access for use in cache tracking and similar situations.
`protected java.lang.String`	`lastModifiedReason` A text field describing the reason for the update or add.
`protected java.util.Date`	`lastModifiedTime` An immutable timestamp reflecting the time when this instance was last updated.
`protected int`	`recordStatus` Initially set to SandPersistMessage.RECORDSTATUS_ACTIVE by the persistence processing on creation, this field is set to RECORDSTATUS_DELETED in response to a SandUpdateMessage ACTION_DELETE.
`static int`	`RECORDSTATUS_ACTIVE` Possible value for recordStatus
`static int`	`RECORDSTATUS_ARCHIVED` Possible value for recordStatus
`static int`	`RECORDSTATUS_DELETED` Possible value for recordStatus
`protected long`	`revisionNumber` An immutable version number updated by the persistence processing on each update.
`protected long`	`uniqueID` An immutable unique identifier generated by the persistence processing when a SandUpdateMessage ACTION_ADD is sent to a DataManager node instance and processed successfully.

Fields inherited from class org.sandev.TaskHeap.structs.SystemStatusStruct
`accessLevel, globalAnnouncement, name`

Fields inherited from interface org.sandev.basics.structs.SandPersistMessage
`WRITEACCESS_NORMAL, WRITEACCESS_READONLY`

Constructor Summary
`SystemStatus()` Default constructor calls init.

Method Summary
`static java.lang.String`	`accessLevelActual2Print(java.lang.String actualVal)` Utility method to transform an actual value for this field into a print value.
`int`	`accessLevelLabelToValue(java.lang.String label)` Given a label, return the value for it.
`static int`	`accessLevelLabelToValueStatic(java.lang.String label)`
`static java.lang.String`	`accessLevelPrint2Actual(java.lang.String printVal)` Utility method to transform a print value for this field into an actual value.
`static java.lang.String`	`accessLevelPrint2Key(java.lang.String printVal)` Utility method to transform a print value for this field into a key value.
`java.lang.String`	`accessLevelValueToLabel(int val)` Given a value, return the declared label for it.
`static java.lang.String`	`accessLevelValueToLabelStatic(int val)`
`org.sandev.basics.structs.SandInstanceMessage`	`cloneMessage()` Calls cloneSystemStatus
`SystemStatus`	`cloneSystemStatus()` Make a deep copy of this SystemStatus.
`org.sandev.basics.structs.SandInstanceMessage`	`convertToSuperstructClass()` Return a new instance of the message associated with the superstruct of this instance.
`void`	`copyDataFrom(SystemStatus other, boolean deepcopy)` Copy all the data from the specified instance.
`void`	`copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.SandInstanceMessage other)` Copy the specified field from the given instance.
`java.lang.String`	`debugDump(java.lang.String prefix)` Dump this instance into a debug printable string.
`void`	`defaultField(java.lang.String fieldname)` Set the specified field to its default value.
`boolean`	`fieldHasFlag(java.lang.String fieldname, int fieldflag)` Return true if the named field declares the indicated flag, false otherwise.
`boolean`	`fieldsValid()` Validate the fields as specified in the SandInstanceMessage interface
`org.sandev.basics.structs.SandAttrVal[]`	`fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields)` Validate the fields as specified in the SandInstanceMessage interface
`org.sandev.basics.structs.SandCollectionMessage`	`find(org.sandev.basics.structs.SandQueryMessage sqm)` Return a matching collection of all directly contained instances matching the given query.
`java.lang.Object`	`generalAccessor(java.lang.String fieldspec)` General field accessor method.
`org.sandev.basics.structs.SandAttrVal`	`generalDereference(java.lang.String fieldspec)` General reference field accessor method.
`void`	`generalModifier(int action, java.lang.String field, int index, java.lang.Object val)` General mutator method.
`int`	`getAccessLevel()` Accessor for accessLevel
`static java.lang.String[]`	`getAccessLevelActualVals()` Return an array of the possible values for this field as Strings.
`static int`	`getAccessLevelDefaultValue()` Default value for accessLevel.
`static java.lang.String`	`getAccessLevelEnumSummary()` Return a single String summary of the possible enum values for debug and similar purposes.
`java.lang.String`	`getAccessLevelFieldPrintValue()` Return the print name of the accessLevel field.
`static boolean`	`getAccessLevelFlag(int fieldflag)` Field flag accessor.
`static int`	`getAccessLevelInvalidValue()` Invalid value for accessLevel.
`static java.lang.String[]`	`getAccessLevelKeyVals()` Return an array of unique keys for the values of this field.
`java.lang.String`	`getAccessLevelMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`static java.lang.String[]`	`getAccessLevelPrintVals()` Return an array of the possible values for this field in display format.
`java.lang.String`	`getAccessLevelPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getAccessLevelRange()` Return the range specification for this field
`java.lang.String`	`getAccessLevelValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String[]`	`getAllFields()` Return an array of all fields for this class.
`int`	`getBaseMemoryUse()` Return the base memory use for this object.
`org.sandev.basics.structs.SandCollectionMessage`	`getCollectionMessage()` Returns a new SystemStatusCollection instance
`java.lang.String[]`	`getContainedMessageFields()` Return an array of all contained message fields.
`java.util.Date`	`getCreationTime()` Accessor for creationTime
`static java.util.Date`	`getCreationTimeDefaultValue()` Default value for creationTime.
`java.lang.String`	`getCreationTimeFieldPrintValue()` Return the print name of the creationTime field.
`static boolean`	`getCreationTimeFlag(int fieldflag)` Field flag accessor.
`static java.util.Date`	`getCreationTimeInvalidValue()` Invalid value for creationTime.
`java.lang.String`	`getCreationTimeMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getCreationTimePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getCreationTimeRange()` Return the range specification for this field
`java.lang.String`	`getCreationTimeValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.util.Date`	`getCreationTimeWithOffset()` Return the date value incorporating the timezone offset specified for the field, if any.
`java.lang.String[]`	`getDisplayFields()` Return an array of the summary field names for this class.
`java.lang.String[]`	`getDisplayFieldsPrint()` Return an array of the summary field print names for this class.
`java.lang.String`	`getDisplayID()` Return the displayID for this message instance
`java.lang.String[]`	`getDisplayValues()` Return the values for the summary fields.
`java.lang.String[]`	`getDisplayValues(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal)` Return the values for the summary fields, including dereference expressions.
`java.lang.String`	`getGlobalAnnouncement()` Accessor for globalAnnouncement
`static java.lang.String`	`getGlobalAnnouncementDefaultValue()` Default value for globalAnnouncement.
`java.lang.String`	`getGlobalAnnouncementFieldPrintValue()` Return the print name of the globalAnnouncement field.
`static boolean`	`getGlobalAnnouncementFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getGlobalAnnouncementInvalidValue()` Invalid value for globalAnnouncement.
`static int`	`getGlobalAnnouncementLengthMax()` Maximum globalAnnouncement length is 2048 characters
`static int`	`getGlobalAnnouncementLengthNorm()` Normal globalAnnouncement length is 512 characters
`java.lang.String`	`getGlobalAnnouncementMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getGlobalAnnouncementPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getGlobalAnnouncementRange()` Return the range specification for this field
`java.lang.String`	`getGlobalAnnouncementValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`org.sandev.basics.structs.SandPersistMessage`	`getInstance(java.lang.String classname, long id)` If this instance directly contains the specified instance, then find it and return it.
`org.sandev.basics.structs.SandInstanceMessage`	`getInstance(java.lang.String classname, java.lang.String fieldname, java.lang.String value)` If this instance directly contains the specified instance, then find it and return it.
`int`	`getInstanceWriteAccess()` Accessor for instanceWriteAccess
`static int`	`getInstanceWriteAccessDefaultValue()` Default value for instanceWriteAccess.
`java.lang.String`	`getInstanceWriteAccessFieldPrintValue()` Return the print name of the instanceWriteAccess field.
`static boolean`	`getInstanceWriteAccessFlag(int fieldflag)` Field flag accessor.
`static int`	`getInstanceWriteAccessInvalidValue()` Invalid value for instanceWriteAccess.
`java.lang.String`	`getInstanceWriteAccessMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getInstanceWriteAccessPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getInstanceWriteAccessRange()` Return the range specification for this field
`java.lang.String`	`getInstanceWriteAccessValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.util.Date`	`getLastAccessedTime()` Accessor for lastAccessedTime
`static java.util.Date`	`getLastAccessedTimeDefaultValue()` Default value for lastAccessedTime.
`java.lang.String`	`getLastAccessedTimeFieldPrintValue()` Return the print name of the lastAccessedTime field.
`static boolean`	`getLastAccessedTimeFlag(int fieldflag)` Field flag accessor.
`static java.util.Date`	`getLastAccessedTimeInvalidValue()` Invalid value for lastAccessedTime.
`java.lang.String`	`getLastAccessedTimeMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getLastAccessedTimePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getLastAccessedTimeRange()` Return the range specification for this field
`java.lang.String`	`getLastAccessedTimeValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.util.Date`	`getLastAccessedTimeWithOffset()` Return the date value incorporating the timezone offset specified for the field, if any.
`java.lang.String`	`getLastModifiedReason()` Accessor for lastModifiedReason
`static java.lang.String`	`getLastModifiedReasonDefaultValue()` Default value for lastModifiedReason.
`java.lang.String`	`getLastModifiedReasonFieldPrintValue()` Return the print name of the lastModifiedReason field.
`static boolean`	`getLastModifiedReasonFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getLastModifiedReasonInvalidValue()` Invalid value for lastModifiedReason.
`static int`	`getLastModifiedReasonLengthMax()` Maximum lastModifiedReason length is 70 characters
`static int`	`getLastModifiedReasonLengthNorm()` Normal lastModifiedReason length is 30 characters
`java.lang.String`	`getLastModifiedReasonMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getLastModifiedReasonPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getLastModifiedReasonRange()` Return the range specification for this field
`java.lang.String`	`getLastModifiedReasonValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.util.Date`	`getLastModifiedTime()` Accessor for lastModifiedTime
`static java.util.Date`	`getLastModifiedTimeDefaultValue()` Default value for lastModifiedTime.
`java.lang.String`	`getLastModifiedTimeFieldPrintValue()` Return the print name of the lastModifiedTime field.
`static boolean`	`getLastModifiedTimeFlag(int fieldflag)` Field flag accessor.
`static java.util.Date`	`getLastModifiedTimeInvalidValue()` Invalid value for lastModifiedTime.
`java.lang.String`	`getLastModifiedTimeMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getLastModifiedTimePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getLastModifiedTimeRange()` Return the range specification for this field
`java.lang.String`	`getLastModifiedTimeValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.util.Date`	`getLastModifiedTimeWithOffset()` Return the date value incorporating the timezone offset specified for the field, if any.
`java.lang.String`	`getLayoutXML()` Return the fieldlayout XML or null if not defined.
`java.lang.String`	`getName()` Accessor for name
`static java.lang.String`	`getNameDefaultValue()` Default value for name.
`java.lang.String`	`getNameFieldPrintValue()` Return the print name of the name field.
`static boolean`	`getNameFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getNameInvalidValue()` Invalid value for name.
`static int`	`getNameLengthMax()` Maximum name length is 60 characters
`static int`	`getNameLengthNorm()` Normal name length is 40 characters
`java.lang.String`	`getNameMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getNamePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getNameRange()` Return the range specification for this field
`java.lang.String`	`getNameValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String`	`getPrintname()` Return the printname of the class
`java.lang.String`	`getPrintnameForField(java.lang.String fieldname)` Given a fieldname, return its declared printname if declared.
`org.sandev.basics.structs.SandQueryMessage`	`getQueryMessage()` Returns a new SystemStatusQuery instance
`int`	`getRecordStatus()` Accessor for recordStatus
`static java.lang.String[]`	`getRecordStatusActualVals()` Return an array of the possible values for this field as Strings.
`static int`	`getRecordStatusDefaultValue()` Default value for recordStatus.
`static java.lang.String`	`getRecordStatusEnumSummary()` Return a single String summary of the possible enum values for debug and similar purposes.
`java.lang.String`	`getRecordStatusFieldPrintValue()` Return the print name of the recordStatus field.
`static boolean`	`getRecordStatusFlag(int fieldflag)` Field flag accessor.
`static int`	`getRecordStatusInvalidValue()` Invalid value for recordStatus.
`static java.lang.String[]`	`getRecordStatusKeyVals()` Return an array of unique keys for the values of this field.
`java.lang.String`	`getRecordStatusMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`static java.lang.String[]`	`getRecordStatusPrintVals()` Return an array of the possible values for this field in display format.
`java.lang.String`	`getRecordStatusPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getRecordStatusRange()` Return the range specification for this field
`java.lang.String`	`getRecordStatusValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`long`	`getRevisionNumber()` Accessor for revisionNumber
`static long`	`getRevisionNumberDefaultValue()` Default value for revisionNumber.
`java.lang.String`	`getRevisionNumberFieldPrintValue()` Return the print name of the revisionNumber field.
`static boolean`	`getRevisionNumberFlag(int fieldflag)` Field flag accessor.
`static long`	`getRevisionNumberInvalidValue()` Invalid value for revisionNumber.
`java.lang.String`	`getRevisionNumberMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getRevisionNumberPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getRevisionNumberRange()` Return the range specification for this field
`java.lang.String`	`getRevisionNumberValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String`	`getShortName()` Returns the unqualified name of this message.
`org.sandev.basics.structs.SandStructMessage`	`getStructMessage()` Returns a new SystemStatus instance
`long`	`getUniqueID()` Accessor for uniqueID
`static long`	`getUniqueIDDefaultValue()` Default value for uniqueID.
`java.lang.String`	`getUniqueIDFieldPrintValue()` Return the print name of the uniqueID field.
`static boolean`	`getUniqueIDFlag(int fieldflag)` Field flag accessor.
`static long`	`getUniqueIDInvalidValue()` Invalid value for uniqueID.
`java.lang.String`	`getUniqueIDMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getUniqueIDPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getUniqueIDRange()` Return the range specification for this field
`java.lang.String`	`getUniqueIDValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`org.sandev.basics.structs.SandUpdateMessage`	`getUpdateMessage()` Returns a new SystemStatusUpdate instance
`java.lang.String`	`getValueForFieldName(java.lang.String fieldname, org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal)` Returns the print representation of the value of the specified field, or the given default value if innaccessible.
`void`	`init()` Initialize all fields to their default values
`boolean`	`isEquivalent(org.sandev.basics.structs.SandMessage sm)` Declared field equivalence check as specified by the SandMessage interface.
`static java.lang.String`	`recordStatusActual2Print(java.lang.String actualVal)` Utility method to transform an actual value for this field into a print value.
`int`	`recordStatusLabelToValue(java.lang.String label)` Given a label, return the value for it.
`static int`	`recordStatusLabelToValueStatic(java.lang.String label)`
`static java.lang.String`	`recordStatusPrint2Actual(java.lang.String printVal)` Utility method to transform a print value for this field into an actual value.
`static java.lang.String`	`recordStatusPrint2Key(java.lang.String printVal)` Utility method to transform a print value for this field into a key value.
`java.lang.String`	`recordStatusValueToLabel(int val)` Given a value, return the declared label for it.
`static java.lang.String`	`recordStatusValueToLabelStatic(int val)`
`java.lang.String[]`	`referenceValidate(java.lang.String[] locations, java.lang.String prefix, org.sandev.basics.util.IDLookup idlookup, org.sandev.basics.util.NameLookup namelookup, org.sandev.basics.util.AuthUser au)` Validate the references as specified in the Resolvable interface.
`void`	`setAccessLevel(int accessLevel)` Mutator for accessLevel
`void`	`setCreationTime(java.util.Date creationTime)` Mutator for creationTime
`void`	`setCreationTime(java.lang.Object creationTime)` Generic mutator for creationTime
`void`	`setCreationTimeWithOffset(java.util.Date val)` Set the date value incorporating the timezone offset specified for the field, if any.
`void`	`setGlobalAnnouncement(java.lang.Object globalAnnouncement)` Generic mutator for globalAnnouncement
`void`	`setGlobalAnnouncement(java.lang.String globalAnnouncement)` Mutator for globalAnnouncement
`void`	`setInstanceWriteAccess(int instanceWriteAccess)` Mutator for instanceWriteAccess
`void`	`setLastAccessedTime(java.util.Date lastAccessedTime)` Mutator for lastAccessedTime
`void`	`setLastAccessedTime(java.lang.Object lastAccessedTime)` Generic mutator for lastAccessedTime
`void`	`setLastAccessedTimeWithOffset(java.util.Date val)` Set the date value incorporating the timezone offset specified for the field, if any.
`void`	`setLastModifiedReason(java.lang.Object lastModifiedReason)` Generic mutator for lastModifiedReason
`void`	`setLastModifiedReason(java.lang.String lastModifiedReason)` Mutator for lastModifiedReason
`void`	`setLastModifiedTime(java.util.Date lastModifiedTime)` Mutator for lastModifiedTime
`void`	`setLastModifiedTime(java.lang.Object lastModifiedTime)` Generic mutator for lastModifiedTime
`void`	`setLastModifiedTimeWithOffset(java.util.Date val)` Set the date value incorporating the timezone offset specified for the field, if any.
`void`	`setName(java.lang.Object name)` Generic mutator for name
`void`	`setName(java.lang.String name)` Mutator for name
`void`	`setRecordStatus(int recordStatus)` Mutator for recordStatus
`void`	`setRevisionNumber(long revisionNumber)` Mutator for revisionNumber
`void`	`setUniqueID(long uniqueID)` Mutator for uniqueID
`SystemStatus`	`shallowCopy()` Make a shallow copy of this SystemStatus.
`java.lang.String`	`toString()` Return a string representation of this object.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

ACCESSLEVEL_NORMAL

public static final int ACCESSLEVEL_NORMAL

Possible value for accessLevel

See Also:: Constant Field Values

ACCESSLEVEL_READONLY

public static final int ACCESSLEVEL_READONLY

Possible value for accessLevel

See Also:: Constant Field Values

ACCESSLEVEL_NOACCESS

public static final int ACCESSLEVEL_NOACCESS

Possible value for accessLevel

See Also:: Constant Field Values

uniqueID

protected long uniqueID

An immutable unique identifier generated by the persistence processing when a SandUpdateMessage ACTION_ADD is sent to a DataManager node instance and processed successfully.

creationTime

protected java.util.Date creationTime

An immutable timestamp reflecting the time when this instance first created. The creationTime is when the instance was first persisted.

lastModifiedTime

protected java.util.Date lastModifiedTime

An immutable timestamp reflecting the time when this instance was last updated. This is set by the persistence processing when the updated instance information is persisted.

lastModifiedReason

protected java.lang.String lastModifiedReason

A text field describing the reason for the update or add. The text can be entered manually by the user, or generated by the application, or a combination of both.

revisionNumber

protected long revisionNumber

An immutable version number updated by the persistence processing on each update. Starts at 1 on initial creation.

lastAccessedTime

protected transient java.util.Date lastAccessedTime

A transient field for tracking object access for use in cache tracking and similar situations.

instanceWriteAccess

protected transient int instanceWriteAccess

A transient field for instance modifiability for use in safe concurrent reference situations like caching.

recordStatus

protected int recordStatus

Initially set to SandPersistMessage.RECORDSTATUS_ACTIVE by the persistence processing on creation, this field is set to RECORDSTATUS_DELETED in response to a SandUpdateMessage ACTION_DELETE. The DataManager will only access persistent information for RECORDSTATUS_ACTIVE unless processing object history. RECORDSTATUS_ARCHIVED is provided to indicate existent data that has been moved offline.

RECORDSTATUS_ACTIVE

public static final int RECORDSTATUS_ACTIVE

Possible value for recordStatus

See Also:: Constant Field Values

RECORDSTATUS_DELETED

public static final int RECORDSTATUS_DELETED

Possible value for recordStatus

See Also:: Constant Field Values

RECORDSTATUS_ARCHIVED

public static final int RECORDSTATUS_ARCHIVED

Possible value for recordStatus

See Also:: Constant Field Values

Constructor Detail

SystemStatus

public SystemStatus()

Default constructor calls init.

Method Detail

getPrintname

public java.lang.String getPrintname()

Return the printname of the class

Specified by:: getPrintname in interface org.sandev.basics.structs.SandStructMessage

fieldHasFlag

public boolean fieldHasFlag(java.lang.String fieldname,
                            int fieldflag)

Return true if the named field declares the indicated flag, false otherwise. See the FIELDFLAG* constants in SandInstanceMessage for supported fieldflag values.

Specified by:: fieldHasFlag in interface org.sandev.basics.structs.SandInstanceMessage

getName

public java.lang.String getName()

Accessor for name

setName

public void setName(java.lang.String name)

Mutator for name

setName

public void setName(java.lang.Object name)

Generic mutator for name

getNameFlag

public static boolean getNameFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getNameLengthNorm

public static int getNameLengthNorm()

Normal name length is 40 characters

getNameLengthMax

public static int getNameLengthMax()

Maximum name length is 60 characters

getNameDefaultValue

public static java.lang.String getNameDefaultValue()

Default value for name. Returns ""

getNameInvalidValue

public static java.lang.String getNameInvalidValue()

Invalid value for name. Returns "INVALID_NAME"

getNamePrintValue

public java.lang.String getNamePrintValue()

Retrieve the current value of this field as a print String. For a String field, this returns the current value. For int, long, double this returns the standard string conversion. For a Date, this returns the default DateFormat format. For an enum, this returns the Actual2Print translation of the current value. For a struct this returns a summary description.

Used for debug output, and as an initial value for transformation and formatting.

getNameFieldPrintValue

public java.lang.String getNameFieldPrintValue()

Return the print name of the name field. If no printname is declared then this returns the field name.

getNameRange

public java.lang.String getNameRange()

Return the range specification for this field

getNameValidityCheck

public java.lang.String getNameValidityCheck()

Return the empty string if the value of this field is valid according to the base SAND declarations. This method supports the fieldValidate method, which is in turn specified by the org.sandev.basics.structs.SandInstanceMessage interface. See the comments there for more information, including a list of error Strings returned from here when a field is not valid.

getNameMetatype

public java.lang.String getNameMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getGlobalAnnouncement

public java.lang.String getGlobalAnnouncement()

Accessor for globalAnnouncement

setGlobalAnnouncement

public void setGlobalAnnouncement(java.lang.String globalAnnouncement)

Mutator for globalAnnouncement

setGlobalAnnouncement

public void setGlobalAnnouncement(java.lang.Object globalAnnouncement)

Generic mutator for globalAnnouncement

getGlobalAnnouncementFlag

public static boolean getGlobalAnnouncementFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getGlobalAnnouncementLengthNorm

public static int getGlobalAnnouncementLengthNorm()

Normal globalAnnouncement length is 512 characters

getGlobalAnnouncementLengthMax

public static int getGlobalAnnouncementLengthMax()

Maximum globalAnnouncement length is 2048 characters

getGlobalAnnouncementDefaultValue

public static java.lang.String getGlobalAnnouncementDefaultValue()

Default value for globalAnnouncement. Returns ""

getGlobalAnnouncementInvalidValue

public static java.lang.String getGlobalAnnouncementInvalidValue()

Invalid value for globalAnnouncement. Returns "INVALID_ANNOUNCEMENT"

getGlobalAnnouncementPrintValue

public java.lang.String getGlobalAnnouncementPrintValue()

Used for debug output, and as an initial value for transformation and formatting.

getGlobalAnnouncementFieldPrintValue

public java.lang.String getGlobalAnnouncementFieldPrintValue()

Return the print name of the globalAnnouncement field. If no printname is declared then this returns the field name.

getGlobalAnnouncementRange

public java.lang.String getGlobalAnnouncementRange()

Return the range specification for this field

getGlobalAnnouncementValidityCheck

public java.lang.String getGlobalAnnouncementValidityCheck()

getGlobalAnnouncementMetatype

public java.lang.String getGlobalAnnouncementMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getAccessLevel

public int getAccessLevel()

Accessor for accessLevel

setAccessLevel

public void setAccessLevel(int accessLevel)

Mutator for accessLevel

accessLevelValueToLabel

public java.lang.String accessLevelValueToLabel(int val)

Given a value, return the declared label for it. This is a conversion method suitable for things like XML serialization where the value must be unique, descriptive, and readable, but is not subject to the same degree of transformation as a UI.

accessLevelValueToLabelStatic

public static java.lang.String accessLevelValueToLabelStatic(int val)

accessLevelLabelToValue

public int accessLevelLabelToValue(java.lang.String label)

Given a label, return the value for it. This is a conversion method performing the inverse of ValueToLabel. See the comments there for more details.

accessLevelLabelToValueStatic

public static int accessLevelLabelToValueStatic(java.lang.String label)

getAccessLevelPrintVals

public static java.lang.String[] getAccessLevelPrintVals()

Return an array of the possible values for this field in display format. These values can be used by a UI directly, or as keys for looking up localized text. These values are not guaranteed to be globally unique, another field with the same possible value may share the same string instance.

getAccessLevelKeyVals

public static java.lang.String[] getAccessLevelKeyVals()

Return an array of unique keys for the values of this field. These keys are globally unique and can be used for looking up localized text without any chance of the same key being used by any other field value in the application.

getAccessLevelActualVals

public static java.lang.String[] getAccessLevelActualVals()

Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.

accessLevelPrint2Key

public static java.lang.String accessLevelPrint2Key(java.lang.String printVal)

Utility method to transform a print value for this field into a key value. See the getAccessLevelPrintVals and getAccessLevelKeyVals methods for details.

accessLevelPrint2Actual

public static java.lang.String accessLevelPrint2Actual(java.lang.String printVal)

Utility method to transform a print value for this field into an actual value. See the getAccessLevelPrintVals and getAccessLevelActualVals methods for details.

accessLevelActual2Print

public static java.lang.String accessLevelActual2Print(java.lang.String actualVal)

Utility method to transform an actual value for this field into a print value. See the getAccessLevelActualVals and getAccessLevelPrintVals methods for details.

getAccessLevelEnumSummary

public static java.lang.String getAccessLevelEnumSummary()

Return a single String summary of the possible enum values for debug and similar purposes.

getAccessLevelFlag

public static boolean getAccessLevelFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getAccessLevelDefaultValue

public static int getAccessLevelDefaultValue()

Default value for accessLevel. Returns ACCESSLEVEL_NORMAL

getAccessLevelInvalidValue

public static int getAccessLevelInvalidValue()

Invalid value for accessLevel. Returns -1

getAccessLevelPrintValue

public java.lang.String getAccessLevelPrintValue()

Used for debug output, and as an initial value for transformation and formatting.

getAccessLevelFieldPrintValue

public java.lang.String getAccessLevelFieldPrintValue()

Return the print name of the accessLevel field. If no printname is declared then this returns the field name.

getAccessLevelRange

public java.lang.String getAccessLevelRange()

Return the range specification for this field

getAccessLevelValidityCheck

public java.lang.String getAccessLevelValidityCheck()

getAccessLevelMetatype

public java.lang.String getAccessLevelMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getUniqueID

public long getUniqueID()

Accessor for uniqueID

Specified by:: getUniqueID in interface org.sandev.basics.structs.SandPersistMessage

setUniqueID

public void setUniqueID(long uniqueID)

Mutator for uniqueID

Specified by:: setUniqueID in interface org.sandev.basics.structs.SandPersistMessage

getUniqueIDFlag

public static boolean getUniqueIDFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getUniqueIDDefaultValue

public static long getUniqueIDDefaultValue()

Default value for uniqueID. Returns 0

getUniqueIDInvalidValue

public static long getUniqueIDInvalidValue()

Invalid value for uniqueID. Returns Long.MIN_VALUE

getUniqueIDPrintValue

public java.lang.String getUniqueIDPrintValue()

Used for debug output, and as an initial value for transformation and formatting.

getUniqueIDFieldPrintValue

public java.lang.String getUniqueIDFieldPrintValue()

Return the print name of the uniqueID field. If no printname is declared then this returns the field name.

getUniqueIDRange

public java.lang.String getUniqueIDRange()

Return the range specification for this field

getUniqueIDValidityCheck

public java.lang.String getUniqueIDValidityCheck()

getUniqueIDMetatype

public java.lang.String getUniqueIDMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getCreationTime

public java.util.Date getCreationTime()

Accessor for creationTime

Specified by:: getCreationTime in interface org.sandev.basics.structs.SandPersistMessage

setCreationTime

public void setCreationTime(java.util.Date creationTime)

Mutator for creationTime

setCreationTime

public void setCreationTime(java.lang.Object creationTime)

Generic mutator for creationTime

getCreationTimeFlag

public static boolean getCreationTimeFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getCreationTimeDefaultValue

public static java.util.Date getCreationTimeDefaultValue()

Default value for creationTime. Returns System.currentTimeMillis()

getCreationTimeInvalidValue

public static java.util.Date getCreationTimeInvalidValue()

Invalid value for creationTime. Returns null

getCreationTimePrintValue

public java.lang.String getCreationTimePrintValue()

Used for debug output, and as an initial value for transformation and formatting.

getCreationTimeFieldPrintValue

public java.lang.String getCreationTimeFieldPrintValue()

Return the print name of the creationTime field. If no printname is declared then this returns the field name.

getCreationTimeRange

public java.lang.String getCreationTimeRange()

Return the range specification for this field

getCreationTimeWithOffset

public java.util.Date getCreationTimeWithOffset()

Return the date value incorporating the timezone offset specified for the field, if any. This method returns the date value of the field from the perspective of the current runtime environment. In other words the local time at the time of the date value for specified time zone.

setCreationTimeWithOffset

public void setCreationTimeWithOffset(java.util.Date val)

Set the date value incorporating the timezone offset specified for the field, if any. See corresponding get method for more info.

getCreationTimeValidityCheck

public java.lang.String getCreationTimeValidityCheck()

getCreationTimeMetatype

public java.lang.String getCreationTimeMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getLastModifiedTime

public java.util.Date getLastModifiedTime()

Accessor for lastModifiedTime

Specified by:: getLastModifiedTime in interface org.sandev.basics.structs.SandPersistMessage

setLastModifiedTime

public void setLastModifiedTime(java.util.Date lastModifiedTime)

Mutator for lastModifiedTime

setLastModifiedTime

public void setLastModifiedTime(java.lang.Object lastModifiedTime)

Generic mutator for lastModifiedTime

getLastModifiedTimeFlag

public static boolean getLastModifiedTimeFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getLastModifiedTimeDefaultValue

public static java.util.Date getLastModifiedTimeDefaultValue()

Default value for lastModifiedTime. Returns System.currentTimeMillis()

getLastModifiedTimeInvalidValue

public static java.util.Date getLastModifiedTimeInvalidValue()

Invalid value for lastModifiedTime. Returns null

getLastModifiedTimePrintValue

public java.lang.String getLastModifiedTimePrintValue()

Used for debug output, and as an initial value for transformation and formatting.

getLastModifiedTimeFieldPrintValue

public java.lang.String getLastModifiedTimeFieldPrintValue()

Return the print name of the lastModifiedTime field. If no printname is declared then this returns the field name.

getLastModifiedTimeRange

public java.lang.String getLastModifiedTimeRange()

Return the range specification for this field

getLastModifiedTimeWithOffset

public java.util.Date getLastModifiedTimeWithOffset()

setLastModifiedTimeWithOffset

public void setLastModifiedTimeWithOffset(java.util.Date val)

Set the date value incorporating the timezone offset specified for the field, if any. See corresponding get method for more info.

getLastModifiedTimeValidityCheck

public java.lang.String getLastModifiedTimeValidityCheck()

getLastModifiedTimeMetatype

public java.lang.String getLastModifiedTimeMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getLastModifiedReason

public java.lang.String getLastModifiedReason()

Accessor for lastModifiedReason

Specified by:: getLastModifiedReason in interface org.sandev.basics.structs.SandPersistMessage

setLastModifiedReason

public void setLastModifiedReason(java.lang.String lastModifiedReason)

Mutator for lastModifiedReason

Specified by:: setLastModifiedReason in interface org.sandev.basics.structs.SandPersistMessage

setLastModifiedReason

public void setLastModifiedReason(java.lang.Object lastModifiedReason)

Generic mutator for lastModifiedReason

getLastModifiedReasonFlag

public static boolean getLastModifiedReasonFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getLastModifiedReasonLengthNorm

public static int getLastModifiedReasonLengthNorm()

Normal lastModifiedReason length is 30 characters

getLastModifiedReasonLengthMax

public static int getLastModifiedReasonLengthMax()

Maximum lastModifiedReason length is 70 characters

getLastModifiedReasonDefaultValue

public static java.lang.String getLastModifiedReasonDefaultValue()

Default value for lastModifiedReason. Returns ""

getLastModifiedReasonInvalidValue

public static java.lang.String getLastModifiedReasonInvalidValue()

Invalid value for lastModifiedReason. Returns null

getLastModifiedReasonPrintValue

public java.lang.String getLastModifiedReasonPrintValue()

Used for debug output, and as an initial value for transformation and formatting.

getLastModifiedReasonFieldPrintValue

public java.lang.String getLastModifiedReasonFieldPrintValue()

Return the print name of the lastModifiedReason field. If no printname is declared then this returns the field name.

getLastModifiedReasonRange

public java.lang.String getLastModifiedReasonRange()

Return the range specification for this field

getLastModifiedReasonValidityCheck

public java.lang.String getLastModifiedReasonValidityCheck()

getLastModifiedReasonMetatype

public java.lang.String getLastModifiedReasonMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getRevisionNumber

public long getRevisionNumber()

Accessor for revisionNumber

Specified by:: getRevisionNumber in interface org.sandev.basics.structs.SandPersistMessage

setRevisionNumber

public void setRevisionNumber(long revisionNumber)

Mutator for revisionNumber

Specified by:: setRevisionNumber in interface org.sandev.basics.structs.SandPersistMessage

getRevisionNumberFlag

public static boolean getRevisionNumberFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getRevisionNumberDefaultValue

public static long getRevisionNumberDefaultValue()

Default value for revisionNumber. Returns 0

getRevisionNumberInvalidValue

public static long getRevisionNumberInvalidValue()

Invalid value for revisionNumber. Returns Long.MIN_VALUE

getRevisionNumberPrintValue

public java.lang.String getRevisionNumberPrintValue()

Used for debug output, and as an initial value for transformation and formatting.

getRevisionNumberFieldPrintValue

public java.lang.String getRevisionNumberFieldPrintValue()

Return the print name of the revisionNumber field. If no printname is declared then this returns the field name.

getRevisionNumberRange

public java.lang.String getRevisionNumberRange()

Return the range specification for this field

getRevisionNumberValidityCheck

public java.lang.String getRevisionNumberValidityCheck()

getRevisionNumberMetatype

public java.lang.String getRevisionNumberMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getLastAccessedTime

public java.util.Date getLastAccessedTime()

Accessor for lastAccessedTime

Specified by:: getLastAccessedTime in interface org.sandev.basics.structs.SandPersistMessage

setLastAccessedTime

public void setLastAccessedTime(java.util.Date lastAccessedTime)

Mutator for lastAccessedTime

Specified by:: setLastAccessedTime in interface org.sandev.basics.structs.SandPersistMessage

setLastAccessedTime

public void setLastAccessedTime(java.lang.Object lastAccessedTime)

Generic mutator for lastAccessedTime

getLastAccessedTimeFlag

public static boolean getLastAccessedTimeFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getLastAccessedTimeDefaultValue

public static java.util.Date getLastAccessedTimeDefaultValue()

Default value for lastAccessedTime. Returns System.currentTimeMillis()

getLastAccessedTimeInvalidValue

public static java.util.Date getLastAccessedTimeInvalidValue()

Invalid value for lastAccessedTime. Returns null

getLastAccessedTimePrintValue

public java.lang.String getLastAccessedTimePrintValue()

Used for debug output, and as an initial value for transformation and formatting.

getLastAccessedTimeFieldPrintValue

public java.lang.String getLastAccessedTimeFieldPrintValue()

Return the print name of the lastAccessedTime field. If no printname is declared then this returns the field name.

getLastAccessedTimeRange

public java.lang.String getLastAccessedTimeRange()

Return the range specification for this field

getLastAccessedTimeWithOffset

public java.util.Date getLastAccessedTimeWithOffset()

setLastAccessedTimeWithOffset

public void setLastAccessedTimeWithOffset(java.util.Date val)

Set the date value incorporating the timezone offset specified for the field, if any. See corresponding get method for more info.

getLastAccessedTimeValidityCheck

public java.lang.String getLastAccessedTimeValidityCheck()

getLastAccessedTimeMetatype

public java.lang.String getLastAccessedTimeMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getInstanceWriteAccess

public int getInstanceWriteAccess()

Accessor for instanceWriteAccess

Specified by:: getInstanceWriteAccess in interface org.sandev.basics.structs.SandPersistMessage

setInstanceWriteAccess

public void setInstanceWriteAccess(int instanceWriteAccess)

Mutator for instanceWriteAccess

Specified by:: setInstanceWriteAccess in interface org.sandev.basics.structs.SandPersistMessage

getInstanceWriteAccessFlag

public static boolean getInstanceWriteAccessFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getInstanceWriteAccessDefaultValue

public static int getInstanceWriteAccessDefaultValue()

Default value for instanceWriteAccess. Returns 0

getInstanceWriteAccessInvalidValue

public static int getInstanceWriteAccessInvalidValue()

Invalid value for instanceWriteAccess. Returns Integer.MIN_VALUE

getInstanceWriteAccessPrintValue

public java.lang.String getInstanceWriteAccessPrintValue()

Used for debug output, and as an initial value for transformation and formatting.

getInstanceWriteAccessFieldPrintValue

public java.lang.String getInstanceWriteAccessFieldPrintValue()

Return the print name of the instanceWriteAccess field. If no printname is declared then this returns the field name.

getInstanceWriteAccessRange

public java.lang.String getInstanceWriteAccessRange()

Return the range specification for this field

getInstanceWriteAccessValidityCheck

public java.lang.String getInstanceWriteAccessValidityCheck()

getInstanceWriteAccessMetatype

public java.lang.String getInstanceWriteAccessMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getRecordStatus

public int getRecordStatus()

Accessor for recordStatus

Specified by:: getRecordStatus in interface org.sandev.basics.structs.SandPersistMessage

setRecordStatus

public void setRecordStatus(int recordStatus)

Mutator for recordStatus

recordStatusValueToLabel

public java.lang.String recordStatusValueToLabel(int val)

recordStatusValueToLabelStatic

public static java.lang.String recordStatusValueToLabelStatic(int val)

recordStatusLabelToValue

public int recordStatusLabelToValue(java.lang.String label)

Given a label, return the value for it. This is a conversion method performing the inverse of ValueToLabel. See the comments there for more details.

recordStatusLabelToValueStatic

public static int recordStatusLabelToValueStatic(java.lang.String label)

getRecordStatusPrintVals

public static java.lang.String[] getRecordStatusPrintVals()

getRecordStatusKeyVals

public static java.lang.String[] getRecordStatusKeyVals()

getRecordStatusActualVals

public static java.lang.String[] getRecordStatusActualVals()

Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.

recordStatusPrint2Key

public static java.lang.String recordStatusPrint2Key(java.lang.String printVal)

Utility method to transform a print value for this field into a key value. See the getRecordStatusPrintVals and getRecordStatusKeyVals methods for details.

recordStatusPrint2Actual

public static java.lang.String recordStatusPrint2Actual(java.lang.String printVal)

Utility method to transform a print value for this field into an actual value. See the getRecordStatusPrintVals and getRecordStatusActualVals methods for details.

recordStatusActual2Print

public static java.lang.String recordStatusActual2Print(java.lang.String actualVal)

Utility method to transform an actual value for this field into a print value. See the getRecordStatusActualVals and getRecordStatusPrintVals methods for details.

getRecordStatusEnumSummary

public static java.lang.String getRecordStatusEnumSummary()

Return a single String summary of the possible enum values for debug and similar purposes.

getRecordStatusFlag

public static boolean getRecordStatusFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getRecordStatusDefaultValue

public static int getRecordStatusDefaultValue()

Default value for recordStatus. Returns 0

getRecordStatusInvalidValue

public static int getRecordStatusInvalidValue()

Invalid value for recordStatus. Returns Integer.MIN_VALUE

getRecordStatusPrintValue

public java.lang.String getRecordStatusPrintValue()

Used for debug output, and as an initial value for transformation and formatting.

getRecordStatusFieldPrintValue

public java.lang.String getRecordStatusFieldPrintValue()

Return the print name of the recordStatus field. If no printname is declared then this returns the field name.

getRecordStatusRange

public java.lang.String getRecordStatusRange()

Return the range specification for this field

getRecordStatusValidityCheck

public java.lang.String getRecordStatusValidityCheck()

getRecordStatusMetatype

public java.lang.String getRecordStatusMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

init

public void init()

Initialize all fields to their default values

getShortName

public java.lang.String getShortName()

Returns the unqualified name of this message.

Specified by:: getShortName in interface org.sandev.basics.structs.SandMessage

getQueryMessage

public org.sandev.basics.structs.SandQueryMessage getQueryMessage()

Returns a new SystemStatusQuery instance

Specified by:: getQueryMessage in interface org.sandev.basics.structs.SandMessage

getCollectionMessage

public org.sandev.basics.structs.SandCollectionMessage getCollectionMessage()

Returns a new SystemStatusCollection instance

Specified by:: getCollectionMessage in interface org.sandev.basics.structs.SandMessage

getUpdateMessage

public org.sandev.basics.structs.SandUpdateMessage getUpdateMessage()

Returns a new SystemStatusUpdate instance

Specified by:: getUpdateMessage in interface org.sandev.basics.structs.SandMessage

getStructMessage

public org.sandev.basics.structs.SandStructMessage getStructMessage()

Returns a new SystemStatus instance

Specified by:: getStructMessage in interface org.sandev.basics.structs.SandMessage

isEquivalent

public boolean isEquivalent(org.sandev.basics.structs.SandMessage sm)

Declared field equivalence check as specified by the SandMessage interface. String values are trimmed before comparison because conversions may occasionally result in trailing whitespace, which should not cause equivalence comparisons to fail. Comparisons are case insensitive since that corresponds to what most people expect, and how most databases work.

When comparing arrays, it is possible that the array elements may have been set to null as part of authorization filtering or similar unusual circumstances. A null array element is only equivalent to another null array element.

Specified by:: isEquivalent in interface org.sandev.basics.structs.SandMessage

getBaseMemoryUse

public int getBaseMemoryUse()

Return the base memory use for this object. This number is a minimum value for estimation purposes, see the comments in the SandStructMessage declaration for details.

Specified by:: getBaseMemoryUse in interface org.sandev.basics.structs.SandMessage

generalModifier

public void generalModifier(int action,
                            java.lang.String field,
                            int index,
                            java.lang.Object val)
                     throws org.sandev.basics.structs.SandException

General mutator method. Specified by SandInstanceMessage interface.

Specified by:: generalModifier in interface org.sandev.basics.structs.SandInstanceMessage

Throws:: org.sandev.basics.structs.SandException

generalDereference

public org.sandev.basics.structs.SandAttrVal generalDereference(java.lang.String fieldspec)

General reference field accessor method. Specified by SandInstanceMessage interface.

Specified by:: generalDereference in interface org.sandev.basics.structs.SandInstanceMessage

generalAccessor

public java.lang.Object generalAccessor(java.lang.String fieldspec)

General field accessor method. Specified by SandInstanceMessage interface.

Specified by:: generalAccessor in interface org.sandev.basics.structs.SandInstanceMessage

getDisplayFields

public java.lang.String[] getDisplayFields()

Return an array of the summary field names for this class.

Specified by:: getDisplayFields in interface org.sandev.basics.structs.SandInstanceMessage

getDisplayFieldsPrint

public java.lang.String[] getDisplayFieldsPrint()

Return an array of the summary field print names for this class.

Specified by:: getDisplayFieldsPrint in interface org.sandev.basics.structs.SandInstanceMessage

getLayoutXML

public java.lang.String getLayoutXML()

Return the fieldlayout XML or null if not defined.

Specified by:: getLayoutXML in interface org.sandev.basics.structs.SandInstanceMessage

getDisplayValues

public java.lang.String[] getDisplayValues()

Return the values for the summary fields. The standard String representation of each value is returned. For Dates, the default DateFormat output is used. For enums, the print value is used. These can be further transformed as needed.

Specified by:: getDisplayValues in interface org.sandev.basics.structs.SandInstanceMessage

getDisplayValues

public java.lang.String[] getDisplayValues(org.sandev.basics.util.IDLookup lookup,
                                           org.sandev.basics.util.AuthUser user,
                                           java.lang.String defaultVal)

Return the values for the summary fields, including dereference expressions.

Specified by:: getDisplayValues in interface org.sandev.basics.util.Resolvable

getValueForFieldName

public java.lang.String getValueForFieldName(java.lang.String fieldname,
                                             org.sandev.basics.util.IDLookup lookup,
                                             org.sandev.basics.util.AuthUser user,
                                             java.lang.String defaultVal)

Returns the print representation of the value of the specified field, or the given default value if innaccessible. A field value may be innaccessible due to authorization, null reference, or other call failure.

getAllFields

public java.lang.String[] getAllFields()

Return an array of all fields for this class.

Specified by:: getAllFields in interface org.sandev.basics.structs.SandInstanceMessage

getContainedMessageFields

public java.lang.String[] getContainedMessageFields()

Return an array of all contained message fields.

Specified by:: getContainedMessageFields in interface org.sandev.basics.structs.SandInstanceMessage

defaultField

public void defaultField(java.lang.String fieldname)

Set the specified field to its default value.

Specified by:: defaultField in interface org.sandev.basics.structs.SandInstanceMessage

getPrintnameForField

public java.lang.String getPrintnameForField(java.lang.String fieldname)

Given a fieldname, return its declared printname if declared. If no printname was declared then this returns the field name.

Specified by:: getPrintnameForField in interface org.sandev.basics.structs.SandInstanceMessage

cloneMessage

public org.sandev.basics.structs.SandInstanceMessage cloneMessage()

Calls cloneSystemStatus

Specified by:: cloneMessage in interface org.sandev.basics.structs.SandInstanceMessage

cloneSystemStatus

public SystemStatus cloneSystemStatus()

Make a deep copy of this SystemStatus. Creates a new instance and then calls copyDataFrom.

shallowCopy

public SystemStatus shallowCopy()

Make a shallow copy of this SystemStatus. Creates a new instance and then calls copyDataFrom.

copyDataFrom

public void copyDataFrom(SystemStatus other,
                         boolean deepcopy)

Copy all the data from the specified instance. If the other instance is null then this method does nothing. If deepcopy is specified then contained structs are copied, otherwise not. The one field this does not copy is instanceWriteAccess, since you need the copied instance to be writeable.

copyFieldValue

public void copyFieldValue(java.lang.String fieldName,
                           org.sandev.basics.structs.SandInstanceMessage other)

Copy the specified field from the given instance.

Specified by:: copyFieldValue in interface org.sandev.basics.structs.SandInstanceMessage

fieldValidate

public org.sandev.basics.structs.SandAttrVal[] fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields)

Validate the fields as specified in the SandInstanceMessage interface

Specified by:: fieldValidate in interface org.sandev.basics.structs.SandInstanceMessage

fieldsValid

public boolean fieldsValid()

Validate the fields as specified in the SandInstanceMessage interface

Specified by:: fieldsValid in interface org.sandev.basics.structs.SandInstanceMessage

referenceValidate

public java.lang.String[] referenceValidate(java.lang.String[] locations,
                                            java.lang.String prefix,
                                            org.sandev.basics.util.IDLookup idlookup,
                                            org.sandev.basics.util.NameLookup namelookup,
                                            org.sandev.basics.util.AuthUser au)
                                     throws org.sandev.basics.structs.SandException

Validate the references as specified in the Resolvable interface.

Specified by:: referenceValidate in interface org.sandev.basics.util.Resolvable

Throws:: org.sandev.basics.structs.SandException

convertToSuperstructClass

public org.sandev.basics.structs.SandInstanceMessage convertToSuperstructClass()

Return a new instance of the message associated with the superstruct of this instance. Return null if the source struct for this message does not extend another struct.

Specified by:: convertToSuperstructClass in interface org.sandev.basics.structs.SandInstanceMessage

debugDump

public java.lang.String debugDump(java.lang.String prefix)

Dump this instance into a debug printable string.

Specified by:: debugDump in interface org.sandev.basics.structs.SandInstanceMessage

getDisplayID

public java.lang.String getDisplayID()

Return the displayID for this message instance

Specified by:: getDisplayID in interface org.sandev.basics.structs.SandInstanceMessage

getInstance

public org.sandev.basics.structs.SandPersistMessage getInstance(java.lang.String classname,
                                                                long id)

If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

Specified by:: getInstance in interface org.sandev.basics.structs.SandStructMessage

getInstance

public org.sandev.basics.structs.SandInstanceMessage getInstance(java.lang.String classname,
                                                                 java.lang.String fieldname,
                                                                 java.lang.String value)

If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

Specified by:: getInstance in interface org.sandev.basics.structs.SandStructMessage

find

public org.sandev.basics.structs.SandCollectionMessage find(org.sandev.basics.structs.SandQueryMessage sqm)

Return a matching collection of all directly contained instances matching the given query.

Specified by:: find in interface org.sandev.basics.structs.SandStructMessage

toString

public java.lang.String toString()

Return a string representation of this object. Uses the declared summary fields minus any dereference expressions.

Overrides:: toString in class java.lang.Object

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.sandev.TaskHeap.sandmessages Class SystemStatus

ACCESSLEVEL_NORMAL

ACCESSLEVEL_READONLY

ACCESSLEVEL_NOACCESS

uniqueID

creationTime

lastModifiedTime

lastModifiedReason

revisionNumber

lastAccessedTime

instanceWriteAccess

recordStatus

RECORDSTATUS_ACTIVE

RECORDSTATUS_DELETED

RECORDSTATUS_ARCHIVED

SystemStatus

getPrintname

fieldHasFlag

getName

setName

setName

getNameFlag

getNameLengthNorm

getNameLengthMax

getNameDefaultValue

getNameInvalidValue

getNamePrintValue

getNameFieldPrintValue

getNameRange

getNameValidityCheck

getNameMetatype

getGlobalAnnouncement

setGlobalAnnouncement

setGlobalAnnouncement

getGlobalAnnouncementFlag

getGlobalAnnouncementLengthNorm

getGlobalAnnouncementLengthMax

getGlobalAnnouncementDefaultValue

getGlobalAnnouncementInvalidValue

getGlobalAnnouncementPrintValue

getGlobalAnnouncementFieldPrintValue

getGlobalAnnouncementRange

getGlobalAnnouncementValidityCheck

getGlobalAnnouncementMetatype

getAccessLevel

setAccessLevel

accessLevelValueToLabel

accessLevelValueToLabelStatic

accessLevelLabelToValue

accessLevelLabelToValueStatic

getAccessLevelPrintVals

getAccessLevelKeyVals

getAccessLevelActualVals

accessLevelPrint2Key

accessLevelPrint2Actual

accessLevelActual2Print

getAccessLevelEnumSummary

getAccessLevelFlag

getAccessLevelDefaultValue

getAccessLevelInvalidValue

getAccessLevelPrintValue

getAccessLevelFieldPrintValue

getAccessLevelRange

getAccessLevelValidityCheck

getAccessLevelMetatype

getUniqueID

setUniqueID

getUniqueIDFlag

getUniqueIDDefaultValue

getUniqueIDInvalidValue

getUniqueIDPrintValue

getUniqueIDFieldPrintValue

getUniqueIDRange

getUniqueIDValidityCheck

getUniqueIDMetatype

getCreationTime

setCreationTime

setCreationTime

getCreationTimeFlag

getCreationTimeDefaultValue

org.sandev.TaskHeap.sandmessages
Class SystemStatus