Reader

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 Reader

java.lang.Object
  org.sandev.basics.structs.BaseUserStruct
      org.sandev.TaskHeap.structs.ReaderStruct
          org.sandev.TaskHeap.sandmessages.Reader

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

public class Reader
extends ReaderStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable, org.sandev.basics.structs.SandPersistMessage, org.sandev.basics.util.AuthUser

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.structs.ReaderStruct
generator: org.sandev.generator.MessageClassGenerator
time: Dec 2, 2005 6:38:52 PM

Field Summary
`protected java.util.Date`	`creationTime` An immutable timestamp reflecting the time when this instance first created.
`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.
`static int`	`USERSTATUS_ACTIVE` Possible value for userStatus
`static int`	`USERSTATUS_INACTIVE` Possible value for userStatus

Fields inherited from class org.sandev.TaskHeap.structs.ReaderStruct

description, email, name, userParams, userStatus

Fields inherited from class org.sandev.basics.structs.BaseUserStruct

password, username

Fields inherited from interface org.sandev.basics.structs.SandInstanceMessage

FIELDCHECK_INVALIDVAL, FIELDCHECK_NOTAREF, FIELDCHECK_NOTINRANGE, FIELDCHECK_NULLARRAY, FIELDCHECK_STRINGOVER, FIELDCHECK_UNKNOWNVAL, FIELDFLAG_BINARY, FIELDFLAG_ENCRYPT, FIELDFLAG_INTERNAL, FIELDFLAG_NOECHO, FIELDFLAG_OBFUSCATE, FIELDFLAG_STRINGPERSIST, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET

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

Method Summary
`org.sandev.basics.structs.SandInstanceMessage`	`cloneMessage()` Calls cloneReader
`Reader`	`cloneReader()` Make a deep copy of this Reader.
`org.sandev.basics.structs.SandInstanceMessage`	`convertToSuperstructClass()` Return a new instance of the message associated with the superstruct of this instance.
`void`	`copyDataFrom(Reader other)` Deep 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
`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.
`java.lang.String[]`	`getAllFields()` Return an array of all fields for this class.
`org.sandev.basics.structs.SandCollectionMessage`	`getCollectionMessage()` Returns a new ReaderCollection instance
`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.lang.String`	`getDescription()` Accessor for description
`static java.lang.String`	`getDescriptionDefaultValue()` Default value for description.
`java.lang.String`	`getDescriptionFieldPrintValue()` Return the print name of the description field.
`static boolean`	`getDescriptionFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getDescriptionInvalidValue()` Invalid value for description.
`static int`	`getDescriptionLengthMax()` Maximum description length is 4096 characters
`static int`	`getDescriptionLengthNorm()` Normal description length is 255 characters
`java.lang.String`	`getDescriptionMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getDescriptionPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getDescriptionRange()` Return the range specification for this field
`java.lang.String`	`getDescriptionValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String[]`	`getDisplayFields()` Return an array of the summary field names for this class.
`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`	`getEmail()` Accessor for email
`static java.lang.String`	`getEmailDefaultValue()` Default value for email.
`java.lang.String`	`getEmailFieldPrintValue()` Return the print name of the email field.
`static boolean`	`getEmailFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getEmailInvalidValue()` Invalid value for email.
`static int`	`getEmailLengthMax()` Maximum email length is 256 characters
`static int`	`getEmailLengthNorm()` Normal email length is 50 characters
`java.lang.String`	`getEmailMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getEmailPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getEmailRange()` Return the range specification for this field
`java.lang.String`	`getEmailValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`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.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 80 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`	`getPassword()` Accessor for password
`static java.lang.String`	`getPasswordDefaultValue()` Default value for password.
`java.lang.String`	`getPasswordFieldPrintValue()` Return the print name of the password field.
`static boolean`	`getPasswordFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getPasswordInvalidValue()` Invalid value for password.
`static int`	`getPasswordLengthMax()` Maximum password length is 80 characters
`static int`	`getPasswordLengthNorm()` Normal password length is 15 characters
`java.lang.String`	`getPasswordMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getPasswordPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getPasswordRange()` Return the range specification for this field
`java.lang.String`	`getPasswordValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`org.sandev.basics.structs.SandQueryMessage`	`getQueryMessage()` Returns a new ReaderQuery 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 Reader 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 ReaderUpdate instance
`java.lang.String`	`getUsername()` Accessor for username
`static java.lang.String`	`getUsernameDefaultValue()` Default value for username.
`java.lang.String`	`getUsernameFieldPrintValue()` Return the print name of the username field.
`static boolean`	`getUsernameFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getUsernameInvalidValue()` Invalid value for username.
`static int`	`getUsernameLengthMax()` Maximum username length is 80 characters
`static int`	`getUsernameLengthNorm()` Normal username length is 15 characters
`java.lang.String`	`getUsernameMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getUsernamePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getUsernameRange()` Return the range specification for this field
`java.lang.String`	`getUsernameValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`DisplayParams`	`getUserParams()` Accessor for userParams
`static DisplayParams`	`getUserParamsDefaultValue()` Default value for userParams.
`java.lang.String`	`getUserParamsFieldPrintValue()` Return the print name of the userParams field.
`static boolean`	`getUserParamsFlag(int fieldflag)` Field flag accessor.
`static DisplayParams`	`getUserParamsInvalidValue()` Invalid value for userParams.
`java.lang.String`	`getUserParamsMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getUserParamsPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getUserParamsRange()` Return the range specification for this field
`java.lang.String`	`getUserParamsValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`int`	`getUserStatus()` Accessor for userStatus
`static java.lang.String[]`	`getUserStatusActualVals()` Return an array of the possible values for this field as Strings.
`static int`	`getUserStatusDefaultValue()` Default value for userStatus.
`static java.lang.String`	`getUserStatusEnumSummary()` Return a single String summary of the possible enum values for debug and similar purposes.
`java.lang.String`	`getUserStatusFieldPrintValue()` Return the print name of the userStatus field.
`static boolean`	`getUserStatusFlag(int fieldflag)` Field flag accessor.
`static int`	`getUserStatusInvalidValue()` Invalid value for userStatus.
`static java.lang.String[]`	`getUserStatusKeyVals()` Return an array of unique keys for the values of this field.
`java.lang.String`	`getUserStatusMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`static java.lang.String[]`	`getUserStatusPrintVals()` Return an array of the possible values for this field in display format.
`java.lang.String`	`getUserStatusPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getUserStatusRange()` Return the range specification for this field
`java.lang.String`	`getUserStatusValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`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.
`boolean`	`isUserStatusActive()` boolean accessor for userStatus value
`boolean`	`isUserStatusInactive()` boolean accessor for userStatus value
`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 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.
`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`	`setCreationTime(java.util.Date creationTime)` Mutator for creationTime
`void`	`setCreationTime(java.lang.Object creationTime)` Generic mutator for creationTime
`void`	`setDescription(java.lang.Object description)` Generic mutator for description
`void`	`setDescription(java.lang.String description)` Mutator for description
`void`	`setEmail(java.lang.Object email)` Generic mutator for email
`void`	`setEmail(java.lang.String email)` Mutator for email
`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`	`setName(java.lang.Object name)` Generic mutator for name
`void`	`setName(java.lang.String name)` Mutator for name
`void`	`setPassword(java.lang.Object password)` Generic mutator for password
`void`	`setPassword(java.lang.String password)` Mutator for password
`void`	`setRecordStatus(int recordStatus)` Mutator for recordStatus
`void`	`setRevisionNumber(long revisionNumber)` Mutator for revisionNumber
`void`	`setUniqueID(long uniqueID)` Mutator for uniqueID
`void`	`setUsername(java.lang.Object username)` Generic mutator for username
`void`	`setUsername(java.lang.String username)` Mutator for username
`void`	`setUserParams(DisplayParams userParams)` Mutator for userParams
`void`	`setUserParams(java.lang.Object userParams)` Generic mutator for userParams
`void`	`setUserStatus(int userStatus)` Mutator for userStatus
`java.lang.String`	`toString()` Return a string representation of this object.
`static java.lang.String`	`userStatusActual2Print(java.lang.String actualVal)` Utility method to transform an actual value for this field into a print value.
`int`	`userStatusLabelToValue(java.lang.String label)` Given a label, return the value for it.
`static java.lang.String`	`userStatusPrint2Actual(java.lang.String printVal)` Utility method to transform a print value for this field into an actual value.
`static java.lang.String`	`userStatusPrint2Key(java.lang.String printVal)` Utility method to transform a print value for this field into a key value.
`java.lang.String`	`userStatusValueToLabel(int val)` Given a value, return the declared label for it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

USERSTATUS_ACTIVE

public static final int USERSTATUS_ACTIVE

Possible value for userStatus

See Also:: Constant Field Values

USERSTATUS_INACTIVE

public static final int USERSTATUS_INACTIVE

Possible value for userStatus

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.

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

Reader

public Reader()

Default constructor calls init.

Method Detail

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

getUsername

public java.lang.String getUsername()

Accessor for username

Specified by:: getUsername in interface org.sandev.basics.util.AuthUser

setUsername

public void setUsername(java.lang.String username)

Mutator for username

Specified by:: setUsername in interface org.sandev.basics.util.AuthUser

setUsername

public void setUsername(java.lang.Object username)

Generic mutator for username

getUsernameFlag

public static boolean getUsernameFlag(int fieldflag)

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

getUsernameLengthNorm

public static int getUsernameLengthNorm()

Normal username length is 15 characters

getUsernameLengthMax

public static int getUsernameLengthMax()

Maximum username length is 80 characters

getUsernameDefaultValue

public static java.lang.String getUsernameDefaultValue()

Default value for username. Returns ""

getUsernameInvalidValue

public static java.lang.String getUsernameInvalidValue()

Invalid value for username. Returns ""

getUsernamePrintValue

public java.lang.String getUsernamePrintValue()

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.

getUsernameFieldPrintValue

public java.lang.String getUsernameFieldPrintValue()

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

getUsernameRange

public java.lang.String getUsernameRange()

Return the range specification for this field

getUsernameValidityCheck

public java.lang.String getUsernameValidityCheck()

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.

getUsernameMetatype

public java.lang.String getUsernameMetatype()

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

getPassword

public java.lang.String getPassword()

Accessor for password

Specified by:: getPassword in interface org.sandev.basics.util.AuthUser

setPassword

public void setPassword(java.lang.String password)

Mutator for password

Specified by:: setPassword in interface org.sandev.basics.util.AuthUser

setPassword

public void setPassword(java.lang.Object password)

Generic mutator for password

getPasswordFlag

public static boolean getPasswordFlag(int fieldflag)

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

getPasswordLengthNorm

public static int getPasswordLengthNorm()

Normal password length is 15 characters

getPasswordLengthMax

public static int getPasswordLengthMax()

Maximum password length is 80 characters

getPasswordDefaultValue

public static java.lang.String getPasswordDefaultValue()

Default value for password. Returns ""

getPasswordInvalidValue

public static java.lang.String getPasswordInvalidValue()

Invalid value for password. Returns "SANDEV_INVALID_PASSWORD"

getPasswordPrintValue

public java.lang.String getPasswordPrintValue()

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

getPasswordFieldPrintValue

public java.lang.String getPasswordFieldPrintValue()

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

getPasswordRange

public java.lang.String getPasswordRange()

Return the range specification for this field

getPasswordValidityCheck

public java.lang.String getPasswordValidityCheck()

getPasswordMetatype

public java.lang.String getPasswordMetatype()

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

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 80 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 "TASKHEAP_INVALID_RESOURCENAME"

getNamePrintValue

public java.lang.String getNamePrintValue()

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()

getNameMetatype

public java.lang.String getNameMetatype()

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

getDescription

public java.lang.String getDescription()

Accessor for description

setDescription

public void setDescription(java.lang.String description)

Mutator for description

setDescription

public void setDescription(java.lang.Object description)

Generic mutator for description

getDescriptionFlag

public static boolean getDescriptionFlag(int fieldflag)

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

getDescriptionLengthNorm

public static int getDescriptionLengthNorm()

Normal description length is 255 characters

getDescriptionLengthMax

public static int getDescriptionLengthMax()

Maximum description length is 4096 characters

getDescriptionDefaultValue

public static java.lang.String getDescriptionDefaultValue()

Default value for description. Returns ""

getDescriptionInvalidValue

public static java.lang.String getDescriptionInvalidValue()

Invalid value for description. Returns "TASKHEAP_INVALID_DESCRIPTION"

getDescriptionPrintValue

public java.lang.String getDescriptionPrintValue()

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

getDescriptionFieldPrintValue

public java.lang.String getDescriptionFieldPrintValue()

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

getDescriptionRange

public java.lang.String getDescriptionRange()

Return the range specification for this field

getDescriptionValidityCheck

public java.lang.String getDescriptionValidityCheck()

getDescriptionMetatype

public java.lang.String getDescriptionMetatype()

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

getEmail

public java.lang.String getEmail()

Accessor for email

setEmail

public void setEmail(java.lang.String email)

Mutator for email

setEmail

public void setEmail(java.lang.Object email)

Generic mutator for email

getEmailFlag

public static boolean getEmailFlag(int fieldflag)

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

getEmailLengthNorm

public static int getEmailLengthNorm()

Normal email length is 50 characters

getEmailLengthMax

public static int getEmailLengthMax()

Maximum email length is 256 characters

getEmailDefaultValue

public static java.lang.String getEmailDefaultValue()

Default value for email. Returns ""

getEmailInvalidValue

public static java.lang.String getEmailInvalidValue()

Invalid value for email. Returns "TASKHEAP_INVALID_EMAIL"

getEmailPrintValue

public java.lang.String getEmailPrintValue()

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

getEmailFieldPrintValue

public java.lang.String getEmailFieldPrintValue()

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

getEmailRange

public java.lang.String getEmailRange()

Return the range specification for this field

getEmailValidityCheck

public java.lang.String getEmailValidityCheck()

getEmailMetatype

public java.lang.String getEmailMetatype()

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

getUserStatus

public int getUserStatus()

Accessor for userStatus

setUserStatus

public void setUserStatus(int userStatus)

Mutator for userStatus

userStatusValueToLabel

public java.lang.String userStatusValueToLabel(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.

userStatusLabelToValue

public int userStatusLabelToValue(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.

getUserStatusPrintVals

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

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.

getUserStatusKeyVals

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

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.

getUserStatusActualVals

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

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

userStatusPrint2Key

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

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

userStatusPrint2Actual

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

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

userStatusActual2Print

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

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

getUserStatusEnumSummary

public static java.lang.String getUserStatusEnumSummary()

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

isUserStatusActive

public boolean isUserStatusActive()

boolean accessor for userStatus value

isUserStatusInactive

public boolean isUserStatusInactive()

boolean accessor for userStatus value

getUserStatusFlag

public static boolean getUserStatusFlag(int fieldflag)

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

getUserStatusDefaultValue

public static int getUserStatusDefaultValue()

Default value for userStatus. Returns USERSTATUS_ACTIVE

getUserStatusInvalidValue

public static int getUserStatusInvalidValue()

Invalid value for userStatus. Returns -1

getUserStatusPrintValue

public java.lang.String getUserStatusPrintValue()

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

getUserStatusFieldPrintValue

public java.lang.String getUserStatusFieldPrintValue()

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

getUserStatusRange

public java.lang.String getUserStatusRange()

Return the range specification for this field

getUserStatusValidityCheck

public java.lang.String getUserStatusValidityCheck()

getUserStatusMetatype

public java.lang.String getUserStatusMetatype()

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

getUserParams

public DisplayParams getUserParams()

Accessor for userParams

setUserParams

public void setUserParams(DisplayParams userParams)

Mutator for userParams

setUserParams

public void setUserParams(java.lang.Object userParams)

Generic mutator for userParams

getUserParamsFlag

public static boolean getUserParamsFlag(int fieldflag)

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

getUserParamsDefaultValue

public static DisplayParams getUserParamsDefaultValue()

Default value for userParams. Returns null

getUserParamsInvalidValue

public static DisplayParams getUserParamsInvalidValue()

Invalid value for userParams. Returns null

getUserParamsPrintValue

public java.lang.String getUserParamsPrintValue()

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

getUserParamsFieldPrintValue

public java.lang.String getUserParamsFieldPrintValue()

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

getUserParamsRange

public java.lang.String getUserParamsRange()

Return the range specification for this field

getUserParamsValidityCheck

public java.lang.String getUserParamsValidityCheck()

getUserParamsMetatype

public java.lang.String getUserParamsMetatype()

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

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

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.

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)

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.

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 ReaderQuery instance

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

getCollectionMessage

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

Returns a new ReaderCollection instance

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

getUpdateMessage

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

Returns a new ReaderUpdate instance

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

getStructMessage

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

Returns a new Reader 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.

Specified by:: isEquivalent 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

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.

toString

public java.lang.String toString()

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

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

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

cloneMessage

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

Calls cloneReader

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

cloneReader

public Reader cloneReader()

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

copyDataFrom

public void copyDataFrom(Reader other)

Deep copy all the data from the specified instance. If the other instance is null then this method does nothing.

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

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 Reader

USERSTATUS_ACTIVE

USERSTATUS_INACTIVE

uniqueID

creationTime

lastModifiedTime

lastModifiedReason

revisionNumber

recordStatus

RECORDSTATUS_ACTIVE

RECORDSTATUS_DELETED

RECORDSTATUS_ARCHIVED

Reader

fieldHasFlag

getUsername

setUsername

setUsername

getUsernameFlag

getUsernameLengthNorm

getUsernameLengthMax

getUsernameDefaultValue

getUsernameInvalidValue

getUsernamePrintValue

getUsernameFieldPrintValue

getUsernameRange

getUsernameValidityCheck

getUsernameMetatype

getPassword

setPassword

setPassword

getPasswordFlag

getPasswordLengthNorm

getPasswordLengthMax

getPasswordDefaultValue

getPasswordInvalidValue

getPasswordPrintValue

getPasswordFieldPrintValue

getPasswordRange

getPasswordValidityCheck

getPasswordMetatype

getName

setName

setName

getNameFlag

getNameLengthNorm

getNameLengthMax

getNameDefaultValue

getNameInvalidValue

getNamePrintValue

getNameFieldPrintValue

getNameRange

getNameValidityCheck

getNameMetatype

getDescription

setDescription

setDescription

getDescriptionFlag

getDescriptionLengthNorm

getDescriptionLengthMax

getDescriptionDefaultValue

getDescriptionInvalidValue

getDescriptionPrintValue

getDescriptionFieldPrintValue

getDescriptionRange

getDescriptionValidityCheck

getDescriptionMetatype

getEmail

setEmail

setEmail

getEmailFlag

getEmailLengthNorm

getEmailLengthMax

getEmailDefaultValue

getEmailInvalidValue

getEmailPrintValue

getEmailFieldPrintValue

getEmailRange

getEmailValidityCheck

getEmailMetatype

getUserStatus

org.sandev.TaskHeap.sandmessages
Class Reader