org.sandev.TaskHeap.sandmessages
Class Account

java.lang.Object
  extended by org.sandev.basics.structs.BaseUserStruct
      extended by org.sandev.TaskHeap.structs.AccountStruct
          extended by org.sandev.TaskHeap.sandmessages.Account
All Implemented Interfaces:
org.sandev.basics.sandmessages.BaseUserInterface, org.sandev.basics.structs.SandInstanceMessage, org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandPersistMessage, org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.AuthUser, org.sandev.basics.util.Resolvable

public class Account
extends AccountStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable, org.sandev.basics.structs.SandPersistMessage, org.sandev.basics.util.AuthUser, org.sandev.basics.sandmessages.BaseUserInterface

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.structs.AccountStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jul 31, 2008 4:34:15 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.TaskHeap.structs.AccountStruct
adsSuspendedUntil, currAssoc, email, heaps, name, userParams
 
Fields inherited from class org.sandev.basics.structs.BaseUserStruct
password, username
 
Constructor Summary
Account()
          Default constructor calls init.
 
Method Summary
 void addHeaps(long element)
          Appends a value to heaps
 void addHeaps(long[] elements)
          Appends an array of values to heaps
 void clearHeaps()
          Clears all values from heaps
 Account cloneAccount()
          Make a deep copy of this Account.
 org.sandev.basics.structs.SandInstanceMessage cloneMessage()
          Calls cloneAccount
 org.sandev.basics.structs.SandInstanceMessage convertToSuperstructClass()
          Return a new instance of the message associated with the superstruct of this instance.
 void copyDataFrom(Account other, boolean deepcopy)
          Copy all the data from the specified instance.
 void copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.SandInstanceMessage other)
          Copy the specified field from the given instance.
 java.lang.String debugDump(java.lang.String prefix)
          Dump this instance into a debug printable string.
 void defaultField(java.lang.String fieldname)
          Set the specified field to its default value.
 boolean fieldHasFlag(java.lang.String fieldname, int fieldflag)
          Return true if the named field declares the indicated flag, false otherwise.
 boolean fieldsValid()
          Validate the fields as specified in the SandInstanceMessage interface
 org.sandev.basics.structs.SandAttrVal[] fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields)
          Validate the fields as specified in the SandInstanceMessage interface
 org.sandev.basics.structs.SandCollectionMessage find(org.sandev.basics.structs.SandQueryMessage sqm)
          Return a matching collection of all directly contained instances matching the given query.
 java.lang.Object generalAccessor(java.lang.String fieldspec)
          General field accessor method.
 org.sandev.basics.structs.SandAttrVal generalDereference(java.lang.String fieldspec)
          General reference field accessor method.
 void generalModifier(int action, java.lang.String field, int index, java.lang.Object val)
          General mutator method.
 java.util.Date getAdsSuspendedUntil()
          Accessor for adsSuspendedUntil
static java.util.Date getAdsSuspendedUntilDefaultValue()
          Default value for adsSuspendedUntil.
 java.lang.String getAdsSuspendedUntilFieldPrintValue()
          Return the print name of the adsSuspendedUntil field.
static boolean getAdsSuspendedUntilFlag(int fieldflag)
          Field flag accessor.
static java.util.Date getAdsSuspendedUntilInvalidValue()
          Invalid value for adsSuspendedUntil.
 java.lang.String getAdsSuspendedUntilMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getAdsSuspendedUntilPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getAdsSuspendedUntilRange()
          Return the range specification for this field
 java.lang.String getAdsSuspendedUntilValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.util.Date getAdsSuspendedUntilWithOffset()
          Return the date value incorporating the timezone offset specified for the field, if any.
 java.lang.String[] getAllFields()
          Return an array of all fields for this class.
 int getBaseMemoryUse()
          Return the base memory use for this object.
 org.sandev.basics.structs.SandCollectionMessage getCollectionMessage()
          Returns a new AccountCollection 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.
 HeapAssociation getCurrAssoc()
          Accessor for currAssoc
static HeapAssociation getCurrAssocDefaultValue()
          Default value for currAssoc.
 java.lang.String getCurrAssocFieldPrintValue()
          Return the print name of the currAssoc field.
static boolean getCurrAssocFlag(int fieldflag)
          Field flag accessor.
static HeapAssociation getCurrAssocInvalidValue()
          Invalid value for currAssoc.
 java.lang.String getCurrAssocMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getCurrAssocPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getCurrAssocRange()
          Return the range specification for this field
 java.lang.String getCurrAssocValidityCheck()
          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[] getDisplayFieldsPrint()
          Return an array of the summary field print names for this class.
 java.lang.String getDisplayID()
          Return the displayID for this message instance
 java.lang.String[] getDisplayValues()
          Return the values for the summary fields.
 java.lang.String[] getDisplayValues(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal)
          Return the values for the summary fields, including dereference expressions.
 java.lang.String 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.
 long[] getHeaps()
          Accessor for heaps.
 long getHeaps(int index)
          Returns the element at the specified index.
static long[] getHeapsDefaultValue()
          Default value for heaps.
static long getHeapsElementInvalidValue()
          Invalid value for heapselement.
 java.lang.String getHeapsFieldPrintValue()
          Return the print name of the heaps field.
static boolean getHeapsFlag(int fieldflag)
          Field flag accessor.
static long[] getHeapsInvalidValue()
          Invalid value for heaps.
 java.lang.String getHeapsMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getHeapsPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getHeapsRange()
          Return the range specification for this field
 java.lang.String getHeapsValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 org.sandev.basics.structs.SandPersistMessage getInstance(java.lang.String classname, long id)
          If this instance directly contains the specified instance, then find it and return it.
 org.sandev.basics.structs.SandInstanceMessage getInstance(java.lang.String classname, java.lang.String fieldname, java.lang.String value)
          If this instance directly contains the specified instance, then find it and return it.
 int getInstanceWriteAccess()
          Accessor for instanceWriteAccess
static int getInstanceWriteAccessDefaultValue()
          Default value for instanceWriteAccess.
 java.lang.String getInstanceWriteAccessFieldPrintValue()
          Return the print name of the instanceWriteAccess field.
static boolean getInstanceWriteAccessFlag(int fieldflag)
          Field flag accessor.
static int getInstanceWriteAccessInvalidValue()
          Invalid value for instanceWriteAccess.
 java.lang.String getInstanceWriteAccessMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getInstanceWriteAccessPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getInstanceWriteAccessRange()
          Return the range specification for this field
 java.lang.String getInstanceWriteAccessValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.util.Date getLastAccessedTime()
          Accessor for lastAccessedTime
static java.util.Date getLastAccessedTimeDefaultValue()
          Default value for lastAccessedTime.
 java.lang.String getLastAccessedTimeFieldPrintValue()
          Return the print name of the lastAccessedTime field.
static boolean getLastAccessedTimeFlag(int fieldflag)
          Field flag accessor.
static java.util.Date getLastAccessedTimeInvalidValue()
          Invalid value for lastAccessedTime.
 java.lang.String getLastAccessedTimeMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getLastAccessedTimePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getLastAccessedTimeRange()
          Return the range specification for this field
 java.lang.String getLastAccessedTimeValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.util.Date getLastAccessedTimeWithOffset()
          Return the date value incorporating the timezone offset specified for the field, if any.
 java.lang.String getLastModifiedReason()
          Accessor for lastModifiedReason
static java.lang.String getLastModifiedReasonDefaultValue()
          Default value for lastModifiedReason.
 java.lang.String getLastModifiedReasonFieldPrintValue()
          Return the print name of the lastModifiedReason field.
static boolean getLastModifiedReasonFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getLastModifiedReasonInvalidValue()
          Invalid value for lastModifiedReason.
static int getLastModifiedReasonLengthMax()
          Maximum lastModifiedReason length is 70 characters
static int getLastModifiedReasonLengthNorm()
          Normal lastModifiedReason length is 30 characters
 java.lang.String getLastModifiedReasonMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getLastModifiedReasonPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getLastModifiedReasonRange()
          Return the range specification for this field
 java.lang.String getLastModifiedReasonValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.util.Date getLastModifiedTime()
          Accessor for lastModifiedTime
static java.util.Date getLastModifiedTimeDefaultValue()
          Default value for lastModifiedTime.
 java.lang.String getLastModifiedTimeFieldPrintValue()
          Return the print name of the lastModifiedTime field.
static boolean getLastModifiedTimeFlag(int fieldflag)
          Field flag accessor.
static java.util.Date getLastModifiedTimeInvalidValue()
          Invalid value for lastModifiedTime.
 java.lang.String getLastModifiedTimeMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getLastModifiedTimePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getLastModifiedTimeRange()
          Return the range specification for this field
 java.lang.String getLastModifiedTimeValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.util.Date getLastModifiedTimeWithOffset()
          Return the date value incorporating the timezone offset specified for the field, if any.
 java.lang.String getLayoutXML()
          Return the fieldlayout XML or null if not defined.
 java.lang.String getName()
          Accessor for name
static java.lang.String getNameDefaultValue()
          Default value for name.
 java.lang.String getNameFieldPrintValue()
          Return the print name of the name field.
static boolean getNameFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getNameInvalidValue()
          Invalid value for name.
static int getNameLengthMax()
          Maximum name length is 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 12 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.
 org.sandev.basics.structs.SandQueryMessage getQueryMessage()
          Returns a new AccountQuery 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 Account 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 AccountUpdate 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 30 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.
 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.
 boolean heapsContains(long val)
          Returns true if heaps contains the specified value.
 int heapsIndexOf(long val)
          Return the index of the specified value in heaps, or -1 if not found.
 void init()
          Initialize all fields to their default values
 void insertHeaps(int index, long value)
          Insert the specified element at the specified index.
 boolean isEquivalent(org.sandev.basics.structs.SandMessage sm)
          Declared field equivalence check as specified by the SandMessage interface.
static java.lang.String recordStatusActual2Print(java.lang.String actualVal)
          Utility method to transform an actual value for this field into a print value.
 int recordStatusLabelToValue(java.lang.String label)
          Given a label, return the value for it.
static int recordStatusLabelToValueStatic(java.lang.String label)
           
static java.lang.String recordStatusPrint2Actual(java.lang.String printVal)
          Utility method to transform a print value for this field into an actual value.
static java.lang.String recordStatusPrint2Key(java.lang.String printVal)
          Utility method to transform a print value for this field into a key value.
 java.lang.String recordStatusValueToLabel(int val)
          Given a value, return the declared label for it.
static java.lang.String recordStatusValueToLabelStatic(int val)
           
 java.lang.String[] referenceValidate(java.lang.String[] locations, java.lang.String prefix, org.sandev.basics.util.IDLookup idlookup, org.sandev.basics.util.NameLookup namelookup, org.sandev.basics.util.AuthUser au)
          Validate the references as specified in the Resolvable interface.
 long removeHeaps(int index)
          Remove the element at the specified index and return it.
 boolean removeHeapsValue(long value)
          Removes the given element from heaps.
 HeapAssociation[] resolveHeapsReferences(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au)
          Converts this array of references into an array of instances, by looking up each reference ID.
 HeapAssociation[] resolveHeapsReferences(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au, boolean allowNulls)
          Converts this array of references into an array of instances, by looking them up.
 HeapAssociation[] resolveHeapsReferences(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au, org.sandev.basics.structs.SandUpdateMessage[] sums)
          Converts this array of references into an array of instances, by looking them up first in the given updates, and then via the IDLookup if not found.
 HeapAssociation[] resolveHeapsReferencesNoLookup()
          A degenerate reference lookup that returns an array of newly allocated org.sandev.TaskHeap.sandmessages.HeapAssociation instances as a standin for a real reference.
 HeapAssociation[] resolveHeapsReferencesNonCrit(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au)
          Resolve the array of reference IDs into an array of instances, without throwing an exception if a given ID cannot be resolved.
 void setAdsSuspendedUntil(java.util.Date adsSuspendedUntil)
          Mutator for adsSuspendedUntil
 void setAdsSuspendedUntil(java.lang.Object adsSuspendedUntil)
          Generic mutator for adsSuspendedUntil
 void setAdsSuspendedUntilWithOffset(java.util.Date val)
          Set the date value incorporating the timezone offset specified for the field, if any.
 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 setCurrAssoc(HeapAssociation currAssoc)
          Mutator for currAssoc
 void setCurrAssoc(java.lang.Object currAssoc)
          Generic mutator for currAssoc
 void setEmail(java.lang.Object email)
          Generic mutator for email
 void setEmail(java.lang.String email)
          Mutator for email
 void setHeaps(int index, long value)
          Set the value at the index specified.
 void setHeaps(long[] heaps)
          Mutator for heaps
 void setInstanceWriteAccess(int instanceWriteAccess)
          Mutator for instanceWriteAccess
 void setLastAccessedTime(java.util.Date lastAccessedTime)
          Mutator for lastAccessedTime
 void setLastAccessedTime(java.lang.Object lastAccessedTime)
          Generic mutator for lastAccessedTime
 void setLastAccessedTimeWithOffset(java.util.Date val)
          Set the date value incorporating the timezone offset specified for the field, if any.
 void setLastModifiedReason(java.lang.Object lastModifiedReason)
          Generic mutator for lastModifiedReason
 void setLastModifiedReason(java.lang.String lastModifiedReason)
          Mutator for lastModifiedReason
 void setLastModifiedTime(java.util.Date lastModifiedTime)
          Mutator for lastModifiedTime
 void setLastModifiedTime(java.lang.Object lastModifiedTime)
          Generic mutator for lastModifiedTime
 void setLastModifiedTimeWithOffset(java.util.Date val)
          Set the date value incorporating the timezone offset specified for the field, if any.
 void setName(java.lang.Object name)
          Generic mutator for name
 void setName(java.lang.String name)
          Mutator for name
 void 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
 Account shallowCopy()
          Make a shallow copy of this Account.
 int sizeofHeaps()
          Returns the size of heaps.
 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

Account

public Account()
Default constructor calls init.

Method Detail

getPrintname

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

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

fieldHasFlag

public boolean fieldHasFlag(java.lang.String fieldname,
                            int fieldflag)
Return true if the named field declares the indicated flag, false otherwise. See the FIELDFLAG* constants in SandInstanceMessage for supported fieldflag values.

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

getUsername

public java.lang.String getUsername()
Accessor for username

Specified by:
getUsername in interface org.sandev.basics.sandmessages.BaseUserInterface
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.sandmessages.BaseUserInterface
Specified by:
setUsername in interface org.sandev.basics.util.AuthUser

setUsername

public void setUsername(java.lang.Object username)
Generic mutator for username

Specified by:
setUsername in interface org.sandev.basics.sandmessages.BaseUserInterface

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 30 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.sandmessages.BaseUserInterface
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.sandmessages.BaseUserInterface
Specified by:
setPassword in interface org.sandev.basics.util.AuthUser

setPassword

public void setPassword(java.lang.Object password)
Generic mutator for password

Specified by:
setPassword in interface org.sandev.basics.sandmessages.BaseUserInterface

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 12 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.


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_NAME"


getNamePrintValue

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

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


getNameFieldPrintValue

public java.lang.String getNameFieldPrintValue()
Return the print name of the name field. If no printname is declared then this returns the field name.


getNameRange

public java.lang.String getNameRange()
Return the range specification for this field


getNameValidityCheck

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


getNameMetatype

public java.lang.String getNameMetatype()
Return the metatype text for this field, or "" if no metatype was declared.


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


getHeaps

public long[] getHeaps()
Accessor for heaps. The returned value may or may not be the actual data member. Always write back a changed array using setHeaps.


setHeaps

public void setHeaps(long[] heaps)
Mutator for heaps


addHeaps

public void addHeaps(long element)
Appends a value to heaps


addHeaps

public void addHeaps(long[] elements)
Appends an array of values to heaps


getHeaps

public long getHeaps(int index)
Returns the element at the specified index. Returns -1 if heaps is null or smaller than index.


setHeaps

public void setHeaps(int index,
                     long value)
Set the value at the index specified.


insertHeaps

public void insertHeaps(int index,
                        long value)
Insert the specified element at the specified index. If the index specified is greater than the index of the last element, then the value is appended to the existing array.


removeHeaps

public long removeHeaps(int index)
Remove the element at the specified index and return it.


removeHeapsValue

public boolean removeHeapsValue(long value)
Removes the given element from heaps. Returns true if the element was found.


clearHeaps

public void clearHeaps()
Clears all values from heaps


heapsContains

public boolean heapsContains(long val)
Returns true if heaps contains the specified value.


heapsIndexOf

public int heapsIndexOf(long val)
Return the index of the specified value in heaps, or -1 if not found.


sizeofHeaps

public int sizeofHeaps()
Returns the size of heaps. Returns -1 if heaps is null.


getHeapsFlag

public static boolean getHeapsFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.


getHeapsDefaultValue

public static long[] getHeapsDefaultValue()
Default value for heaps. Returns new long[0]


getHeapsElementInvalidValue

public static long getHeapsElementInvalidValue()
Invalid value for heapselement. Returns Long.MIN_VALUE


getHeapsInvalidValue

public static long[] getHeapsInvalidValue()
Invalid value for heaps. Returns null


getHeapsPrintValue

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


getHeapsFieldPrintValue

public java.lang.String getHeapsFieldPrintValue()
Return the print name of the heaps field. If no printname is declared then this returns the field name.


getHeapsRange

public java.lang.String getHeapsRange()
Return the range specification for this field


resolveHeapsReferencesNoLookup

public HeapAssociation[] resolveHeapsReferencesNoLookup()
A degenerate reference lookup that returns an array of newly allocated org.sandev.TaskHeap.sandmessages.HeapAssociation instances as a standin for a real reference.


resolveHeapsReferencesNonCrit

public HeapAssociation[] resolveHeapsReferencesNonCrit(org.sandev.basics.util.IDLookup lookup,
                                                       org.sandev.basics.util.AuthUser au)
Resolve the array of reference IDs into an array of instances, without throwing an exception if a given ID cannot be resolved. This supports the UI, which calls this method to get detail on references for display. If the detail is not found, then it's not critical so nulls are allowed in the returned array.

Null entries are necessary to allow for fixing bad references in the UI. Bad references should never happen, but if they do then you want to be able to see them and fix them through the standard UI. If you see that the third reference is null, then you can remove it provided you have the array to work with.


resolveHeapsReferences

public HeapAssociation[] resolveHeapsReferences(org.sandev.basics.util.IDLookup lookup,
                                                org.sandev.basics.util.AuthUser au)
                                         throws org.sandev.basics.structs.SandException
Converts this array of references into an array of instances, by looking up each reference ID. If any of the references are invalid or anything else goes wrong, then this method throws. A successful return means all references were resolved.

Throws:
org.sandev.basics.structs.SandException

resolveHeapsReferences

public HeapAssociation[] resolveHeapsReferences(org.sandev.basics.util.IDLookup lookup,
                                                org.sandev.basics.util.AuthUser au,
                                                boolean allowNulls)
                                         throws org.sandev.basics.structs.SandException
Converts this array of references into an array of instances, by looking them up.

Throws:
org.sandev.basics.structs.SandException

resolveHeapsReferences

public HeapAssociation[] resolveHeapsReferences(org.sandev.basics.util.IDLookup lookup,
                                                org.sandev.basics.util.AuthUser au,
                                                org.sandev.basics.structs.SandUpdateMessage[] sums)
                                         throws org.sandev.basics.structs.SandException
Converts this array of references into an array of instances, by looking them up first in the given updates, and then via the IDLookup if not found. This allows for resolving the references against outstanding updates for the most recent data, including new instances with temporary IDs.

Throws:
org.sandev.basics.structs.SandException

getHeapsValidityCheck

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


getHeapsMetatype

public java.lang.String getHeapsMetatype()
Return the metatype text for this field, or "" if no metatype was declared.


getAdsSuspendedUntil

public java.util.Date getAdsSuspendedUntil()
Accessor for adsSuspendedUntil


setAdsSuspendedUntil

public void setAdsSuspendedUntil(java.util.Date adsSuspendedUntil)
Mutator for adsSuspendedUntil


setAdsSuspendedUntil

public void setAdsSuspendedUntil(java.lang.Object adsSuspendedUntil)
Generic mutator for adsSuspendedUntil


getAdsSuspendedUntilFlag

public static boolean getAdsSuspendedUntilFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.


getAdsSuspendedUntilDefaultValue

public static java.util.Date getAdsSuspendedUntilDefaultValue()
Default value for adsSuspendedUntil. Returns "Jan 1, 2002 11:00 PM"


getAdsSuspendedUntilInvalidValue

public static java.util.Date getAdsSuspendedUntilInvalidValue()
Invalid value for adsSuspendedUntil. Returns null


getAdsSuspendedUntilPrintValue

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


getAdsSuspendedUntilFieldPrintValue

public java.lang.String getAdsSuspendedUntilFieldPrintValue()
Return the print name of the adsSuspendedUntil field. If no printname is declared then this returns the field name.


getAdsSuspendedUntilRange

public java.lang.String getAdsSuspendedUntilRange()
Return the range specification for this field


getAdsSuspendedUntilWithOffset

public java.util.Date getAdsSuspendedUntilWithOffset()
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.


setAdsSuspendedUntilWithOffset

public void setAdsSuspendedUntilWithOffset(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.


getAdsSuspendedUntilValidityCheck

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


getAdsSuspendedUntilMetatype

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


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


getUserParamsMetatype

public java.lang.String getUserParamsMetatype()
Return the metatype text for this field, or "" if no metatype was declared.


getCurrAssoc

public HeapAssociation getCurrAssoc()
Accessor for currAssoc


setCurrAssoc

public void setCurrAssoc(HeapAssociation currAssoc)
Mutator for currAssoc


setCurrAssoc

public void setCurrAssoc(java.lang.Object currAssoc)
Generic mutator for currAssoc


getCurrAssocFlag

public static boolean getCurrAssocFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.


getCurrAssocDefaultValue

public static HeapAssociation getCurrAssocDefaultValue()
Default value for currAssoc. Returns null


getCurrAssocInvalidValue

public static HeapAssociation getCurrAssocInvalidValue()
Invalid value for currAssoc. Returns null


getCurrAssocPrintValue

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


getCurrAssocFieldPrintValue

public java.lang.String getCurrAssocFieldPrintValue()
Return the print name of the currAssoc field. If no printname is declared then this returns the field name.


getCurrAssocRange

public java.lang.String getCurrAssocRange()
Return the range specification for this field


getCurrAssocValidityCheck

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


getCurrAssocMetatype

public java.lang.String getCurrAssocMetatype()
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.sandmessages.BaseUserInterface
Specified by:
getUniqueID in interface org.sandev.basics.structs.SandPersistMessage
Specified by:
getUniqueID in interface org.sandev.basics.util.AuthUser

setUniqueID

public void setUniqueID(long uniqueID)
Mutator for uniqueID

Specified by:
setUniqueID in interface org.sandev.basics.sandmessages.BaseUserInterface
Specified by:
setUniqueID in interface org.sandev.basics.structs.SandPersistMessage
Specified by:
setUniqueID in interface org.sandev.basics.util.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 org.sandev.basics.sandmessages.BaseUserInterface
Specified by:
getCreationTime in interface org.sandev.basics.structs.SandPersistMessage

setCreationTime

public void setCreationTime(java.util.Date creationTime)
Mutator for creationTime

Specified by:
setCreationTime in interface org.sandev.basics.sandmessages.BaseUserInterface

setCreationTime

public void setCreationTime(java.lang.Object creationTime)
Generic mutator for creationTime

Specified by:
setCreationTime in interface org.sandev.basics.sandmessages.BaseUserInterface

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 org.sandev.basics.sandmessages.BaseUserInterface
Specified by:
getLastModifiedTime in interface org.sandev.basics.structs.SandPersistMessage

setLastModifiedTime

public void setLastModifiedTime(java.util.Date lastModifiedTime)
Mutator for lastModifiedTime

Specified by:
setLastModifiedTime in interface org.sandev.basics.sandmessages.BaseUserInterface

setLastModifiedTime

public void setLastModifiedTime(java.lang.Object lastModifiedTime)
Generic mutator for lastModifiedTime

Specified by:
setLastModifiedTime in interface org.sandev.basics.sandmessages.BaseUserInterface

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:
getLastModifiedReason in interface org.sandev.basics.sandmessages.BaseUserInterface
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.sandmessages.BaseUserInterface
Specified by:
setLastModifiedReason in interface org.sandev.basics.structs.SandPersistMessage

setLastModifiedReason

public void setLastModifiedReason(java.lang.Object lastModifiedReason)
Generic mutator for lastModifiedReason

Specified by:
setLastModifiedReason in interface org.sandev.basics.sandmessages.BaseUserInterface

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


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


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


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


getRevisionNumberMetatype

public java.lang.String getRevisionNumberMetatype()
Return the metatype text for this field, or "" if no metatype was declared.


getLastAccessedTime

public java.util.Date getLastAccessedTime()
Accessor for lastAccessedTime

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

setLastAccessedTime

public void setLastAccessedTime(java.util.Date lastAccessedTime)
Mutator for lastAccessedTime

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

setLastAccessedTime

public void setLastAccessedTime(java.lang.Object lastAccessedTime)
Generic mutator for lastAccessedTime

Specified by:
setLastAccessedTime in interface org.sandev.basics.sandmessages.BaseUserInterface

getLastAccessedTimeFlag

public static boolean getLastAccessedTimeFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.


getLastAccessedTimeDefaultValue

public static java.util.Date getLastAccessedTimeDefaultValue()
Default value for lastAccessedTime. Returns System.currentTimeMillis()


getLastAccessedTimeInvalidValue

public static java.util.Date getLastAccessedTimeInvalidValue()
Invalid value for lastAccessedTime. Returns null


getLastAccessedTimePrintValue

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


getLastAccessedTimeFieldPrintValue

public java.lang.String getLastAccessedTimeFieldPrintValue()
Return the print name of the lastAccessedTime field. If no printname is declared then this returns the field name.


getLastAccessedTimeRange

public java.lang.String getLastAccessedTimeRange()
Return the range specification for this field


getLastAccessedTimeWithOffset

public java.util.Date getLastAccessedTimeWithOffset()
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.


setLastAccessedTimeWithOffset

public void setLastAccessedTimeWithOffset(java.util.Date val)
Set the date value incorporating the timezone offset specified for the field, if any. See corresponding get method for more info.


getLastAccessedTimeValidityCheck

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


getLastAccessedTimeMetatype

public java.lang.String getLastAccessedTimeMetatype()
Return the metatype text for this field, or "" if no metatype was declared.


getInstanceWriteAccess

public int getInstanceWriteAccess()
Accessor for instanceWriteAccess

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

setInstanceWriteAccess

public void setInstanceWriteAccess(int instanceWriteAccess)
Mutator for instanceWriteAccess

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

getInstanceWriteAccessFlag

public static boolean getInstanceWriteAccessFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.


getInstanceWriteAccessDefaultValue

public static int getInstanceWriteAccessDefaultValue()
Default value for instanceWriteAccess. Returns 0


getInstanceWriteAccessInvalidValue

public static int getInstanceWriteAccessInvalidValue()
Invalid value for instanceWriteAccess. Returns Integer.MIN_VALUE


getInstanceWriteAccessPrintValue

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


getInstanceWriteAccessFieldPrintValue

public java.lang.String getInstanceWriteAccessFieldPrintValue()
Return the print name of the instanceWriteAccess field. If no printname is declared then this returns the field name.


getInstanceWriteAccessRange

public java.lang.String getInstanceWriteAccessRange()
Return the range specification for this field


getInstanceWriteAccessValidityCheck

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


getInstanceWriteAccessMetatype

public java.lang.String getInstanceWriteAccessMetatype()
Return the metatype text for this field, or "" if no metatype was declared.


getRecordStatus

public int getRecordStatus()
Accessor for recordStatus

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

setRecordStatus

public void setRecordStatus(int recordStatus)
Mutator for recordStatus

Specified by:
setRecordStatus in interface org.sandev.basics.sandmessages.BaseUserInterface

recordStatusValueToLabel

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


recordStatusValueToLabelStatic

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

recordStatusLabelToValue

public int recordStatusLabelToValue(java.lang.String label)
Given a label, return the value for it. This is a conversion method performing the inverse of ValueToLabel. See the comments there for more details.


recordStatusLabelToValueStatic

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

getRecordStatusPrintVals

public static java.lang.String[] getRecordStatusPrintVals()
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.


getRecordStatusKeyVals

public static java.lang.String[] getRecordStatusKeyVals()
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.


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


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


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

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

getCollectionMessage

public org.sandev.basics.structs.SandCollectionMessage getCollectionMessage()
Returns a new AccountCollection instance

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

getUpdateMessage

public org.sandev.basics.structs.SandUpdateMessage getUpdateMessage()
Returns a new AccountUpdate instance

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

getStructMessage

public org.sandev.basics.structs.SandStructMessage getStructMessage()
Returns a new Account instance

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

isEquivalent

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

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

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

getBaseMemoryUse

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

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

generalModifier

public void generalModifier(int action,
                            java.lang.String field,
                            int index,
                            java.lang.Object val)
                     throws org.sandev.basics.structs.SandException
General mutator method. Specified by SandInstanceMessage interface.

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

generalDereference

public org.sandev.basics.structs.SandAttrVal generalDereference(java.lang.String fieldspec)
General reference field accessor method. Specified by SandInstanceMessage interface.

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

generalAccessor

public java.lang.Object generalAccessor(java.lang.String fieldspec)
General field accessor method. Specified by SandInstanceMessage interface.

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

getDisplayFields

public java.lang.String[] getDisplayFields()
Return an array of the summary field names for this class.

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

getDisplayFieldsPrint

public java.lang.String[] getDisplayFieldsPrint()
Return an array of the summary field print names for this class.

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

getLayoutXML

public java.lang.String getLayoutXML()
Return the fieldlayout XML or null if not defined.

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

getDisplayValues

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

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

getDisplayValues

public java.lang.String[] getDisplayValues(org.sandev.basics.util.IDLookup lookup,
                                           org.sandev.basics.util.AuthUser user,
                                           java.lang.String defaultVal)
Return the values for the summary fields, including dereference expressions.

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

getValueForFieldName

public java.lang.String getValueForFieldName(java.lang.String fieldname,
                                             org.sandev.basics.util.IDLookup lookup,
                                             org.sandev.basics.util.AuthUser user,
                                             java.lang.String defaultVal)
Returns the print representation of the value of the specified field, or the given default value if innaccessible. A field value may be innaccessible due to authorization, null reference, or other call failure.

Specified by:
getValueForFieldName in interface org.sandev.basics.sandmessages.BaseUserInterface

getAllFields

public java.lang.String[] getAllFields()
Return an array of all fields for this class.

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

getContainedMessageFields

public java.lang.String[] getContainedMessageFields()
Return an array of all contained message fields.

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

defaultField

public void defaultField(java.lang.String fieldname)
Set the specified field to its default value.

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

getPrintnameForField

public java.lang.String getPrintnameForField(java.lang.String fieldname)
Given a fieldname, return its declared printname if declared. If no printname was declared then this returns the field name.

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

cloneMessage

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

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

cloneAccount

public Account cloneAccount()
Make a deep copy of this Account. Creates a new instance and then calls copyDataFrom.


shallowCopy

public Account shallowCopy()
Make a shallow copy of this Account. Creates a new instance and then calls copyDataFrom.


copyDataFrom

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


copyFieldValue

public void copyFieldValue(java.lang.String fieldName,
                           org.sandev.basics.structs.SandInstanceMessage other)
Copy the specified field from the given instance.

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

fieldValidate

public org.sandev.basics.structs.SandAttrVal[] fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields)
Validate the fields as specified in the SandInstanceMessage interface

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

fieldsValid

public boolean fieldsValid()
Validate the fields as specified in the SandInstanceMessage interface

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

referenceValidate

public java.lang.String[] referenceValidate(java.lang.String[] locations,
                                            java.lang.String prefix,
                                            org.sandev.basics.util.IDLookup idlookup,
                                            org.sandev.basics.util.NameLookup namelookup,
                                            org.sandev.basics.util.AuthUser au)
                                     throws org.sandev.basics.structs.SandException
Validate the references as specified in the Resolvable interface.

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

convertToSuperstructClass

public org.sandev.basics.structs.SandInstanceMessage convertToSuperstructClass()
Return a new instance of the message associated with the superstruct of this instance. Return null if the source struct for this message does not extend another struct.

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

debugDump

public java.lang.String debugDump(java.lang.String prefix)
Dump this instance into a debug printable string.

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

getDisplayID

public java.lang.String getDisplayID()
Return the displayID for this message instance

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

getInstance

public org.sandev.basics.structs.SandPersistMessage getInstance(java.lang.String classname,
                                                                long id)
If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

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

getInstance

public org.sandev.basics.structs.SandInstanceMessage getInstance(java.lang.String classname,
                                                                 java.lang.String fieldname,
                                                                 java.lang.String value)
If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

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

find

public org.sandev.basics.structs.SandCollectionMessage find(org.sandev.basics.structs.SandQueryMessage sqm)
Return a matching collection of all directly contained instances matching the given query.

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

toString

public java.lang.String toString()
Return a string representation of this object. Uses the declared summary fields minus any dereference expressions.

Overrides:
toString in class java.lang.Object