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.basics.sandmessages
Class BaseUserEmail

java.lang.Object
  extended by org.sandev.basics.structs.BaseUserEmailStruct
      extended by org.sandev.basics.sandmessages.BaseUserEmail
All Implemented Interfaces:
SandInstanceMessage, SandMessage, SandPersistMessage, SandStructMessage, AuthUser, Resolvable
public class BaseUserEmail
extends BaseUserEmailStruct
implements SandStructMessage, Resolvable, SandPersistMessage, AuthUser

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.structs.BaseUserEmailStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jul 31, 2008 4:34:14 PM

Field Summary
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.basics.structs.BaseUserEmailStruct
email, password
 
Fields inherited from interface org.sandev.basics.structs.SandInstanceMessage
FIELDCHECK_EMPTYSTRINGPRINTVAL, 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_SUMMARYEDIT, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET
 
Fields inherited from interface org.sandev.basics.structs.SandPersistMessage
WRITEACCESS_NORMAL, WRITEACCESS_READONLY
 
Fields inherited from interface org.sandev.basics.structs.SandInstanceMessage
FIELDCHECK_EMPTYSTRINGPRINTVAL, 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_SUMMARYEDIT, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET
 
Fields inherited from interface org.sandev.basics.structs.SandInstanceMessage
FIELDCHECK_EMPTYSTRINGPRINTVAL, 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_SUMMARYEDIT, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET
 
Constructor Summary
BaseUserEmail()
          Default constructor calls init.
 
Method Summary
 BaseUserEmail cloneBaseUserEmail()
          Make a deep copy of this BaseUserEmail.
 SandInstanceMessage cloneMessage()
          Calls cloneBaseUserEmail
 SandInstanceMessage convertToSuperstructClass()
          Return a new instance of the message associated with the superstruct of this instance.
 void copyDataFrom(BaseUserEmail other, boolean deepcopy)
          Copy all the data from the specified instance.
 void copyFieldValue(java.lang.String fieldName, 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
 SandAttrVal[] fieldValidate(SandAttrVal[] checkFields)
          Validate the fields as specified in the SandInstanceMessage interface
 SandCollectionMessage find(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.
 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.
 int getBaseMemoryUse()
          Return the base memory use for this object.
 SandCollectionMessage getCollectionMessage()
          Returns a new BaseUserEmailCollection 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(IDLookup lookup, 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 80 characters
static int getEmailLengthNorm()
          Normal email length is 30 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.
 SandPersistMessage getInstance(java.lang.String classname, long id)
          If this instance directly contains the specified instance, then find it and return it.
 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 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.
 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.
 SandQueryMessage getQueryMessage()
          Returns a new BaseUserEmailQuery 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.
 SandStructMessage getStructMessage()
          Returns a new BaseUserEmail 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.
 SandUpdateMessage getUpdateMessage()
          Returns a new BaseUserEmailUpdate instance
 java.lang.String getUsername()
          Return the email field as the username.
 java.lang.String getValueForFieldName(java.lang.String fieldname, IDLookup lookup, 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(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, IDLookup idlookup, NameLookup namelookup, 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 setCreationTimeWithOffset(java.util.Date val)
          Set the date value incorporating the timezone offset specified for the field, if any.
 void setEmail(java.lang.Object email)
          Generic mutator for email
 void setEmail(java.lang.String email)
          Mutator for email
 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 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 val)
          Set the email field from the given object.
 void setUsername(java.lang.String val)
          Set the email field from the given username.
 BaseUserEmail shallowCopy()
          Make a shallow copy of this BaseUserEmail.
 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

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

BaseUserEmail

public BaseUserEmail()
Default constructor calls init.

Method Detail

getPrintname

public java.lang.String getPrintname()
Return the printname of the class

Specified by:
getPrintname in interface 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 SandInstanceMessage

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 30 characters

getEmailLengthMax

public static int getEmailLengthMax()
Maximum email length is 80 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 ""

getEmailPrintValue

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

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

getEmailMetatype

public java.lang.String getEmailMetatype()
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 AuthUser

setPassword

public void setPassword(java.lang.String password)
Mutator for password

Specified by:
setPassword in interface 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()
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.

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

getPasswordMetatype

public java.lang.String getPasswordMetatype()
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 SandPersistMessage
Specified by:
getUniqueID in interface AuthUser

setUniqueID

public void setUniqueID(long uniqueID)
Mutator for uniqueID

Specified by:
setUniqueID in interface SandPersistMessage
Specified by:
setUniqueID in interface AuthUser

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

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

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

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

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

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

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

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: