org.sandev.TaskHeap.sandmessages
Class TaskType

java.lang.Object
  org.sandev.TaskHeap.structs.TaskTypeStruct
      org.sandev.TaskHeap.sandmessages.TaskType

All Implemented Interfaces:

org.sandev.basics.util.Resolvable, org.sandev.basics.structs.SandInstanceMessage, org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandPersistMessage, org.sandev.basics.structs.SandStructMessage

public class TaskType

extends TaskTypeStruct

implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable, org.sandev.basics.structs.SandPersistMessage

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

Field Summary

protected java.util.Date	creationTime An immutable timestamp reflecting the time when this instance first created.
protected java.lang.String	lastModifiedReason A text field describing the reason for the update or add.
protected java.util.Date	lastModifiedTime An immutable timestamp reflecting the time when this instance was last updated.
protected int	recordStatus Initially set to SandPersistMessage.RECORDSTATUS_ACTIVE by the persistence processing on creation, this field is set to RECORDSTATUS_DELETED in response to a SandUpdateMessage ACTION_DELETE.
static int	RECORDSTATUS_ACTIVE Possible value for recordStatus
static int	RECORDSTATUS_ARCHIVED Possible value for recordStatus
static int	RECORDSTATUS_DELETED Possible value for recordStatus
protected long	revisionNumber An immutable version number updated by the persistence processing on each update.
protected long	uniqueID An immutable unique identifier generated by the persistence processing when a SandUpdateMessage ACTION_ADD is sent to a DataManager node instance and processed successfully.

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

description, name, phases

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

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

Constructor Summary

TaskType()
Default constructor calls init.

Method Summary

void	addPhases(long element) Appends a value to phases
void	addPhases(long[] elements) Appends an array of values to phases
void	clearPhases() Clears all values from phases
org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls cloneTaskType
TaskType	cloneTaskType() Make a deep copy of this TaskType.
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(TaskType other) Deep copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.SandInstanceMessage other) Copy the specified field from the given instance.
java.lang.String	debugDump(java.lang.String prefix) Dump this instance into a debug printable string.
void	defaultField(java.lang.String fieldname) Set the specified field to its default value.
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
boolean	fieldsValid() Validate the fields as specified in the SandInstanceMessage interface
org.sandev.basics.structs.SandAttrVal[]	fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
java.lang.Object	generalAccessor(java.lang.String fieldspec) General field accessor method.
org.sandev.basics.structs.SandAttrVal	generalDereference(java.lang.String fieldspec) General reference field accessor method.
void	generalModifier(int action, java.lang.String field, int index, java.lang.Object val) General mutator method.
java.lang.String[]	getAllFields() Return an array of all fields for this class.
org.sandev.basics.structs.SandCollectionMessage	getCollectionMessage() Returns a new TaskTypeCollection instance
java.util.Date	getCreationTime() Accessor for creationTime
static java.util.Date	getCreationTimeDefaultValue() Default value for creationTime.
java.lang.String	getCreationTimeFieldPrintValue() Return the print name of the creationTime field.
static boolean	getCreationTimeFlag(int fieldflag) Field flag accessor.
static java.util.Date	getCreationTimeInvalidValue() Invalid value for creationTime.
java.lang.String	getCreationTimeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getCreationTimePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getCreationTimeRange() Return the range specification for this field
java.lang.String	getCreationTimeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getDescription() Accessor for description
static java.lang.String	getDescriptionDefaultValue() Default value for description.
java.lang.String	getDescriptionFieldPrintValue() Return the print name of the description field.
static boolean	getDescriptionFlag(int fieldflag) Field flag accessor.
static java.lang.String	getDescriptionInvalidValue() Invalid value for description.
static int	getDescriptionLengthMax() Maximum description length is 1048576 characters
static int	getDescriptionLengthNorm() Normal description length is 512 characters
java.lang.String	getDescriptionMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getDescriptionPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDescriptionRange() Return the range specification for this field
java.lang.String	getDescriptionValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String[]	getDisplayFields() Return an array of the summary field names for this class.
java.lang.String[]	getDisplayValues() Return the values for the summary fields.
java.lang.String[]	getDisplayValues(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Return the values for the summary fields, including dereference expressions.
java.lang.String	getLastModifiedReason() Accessor for lastModifiedReason
static java.lang.String	getLastModifiedReasonDefaultValue() Default value for lastModifiedReason.
java.lang.String	getLastModifiedReasonFieldPrintValue() Return the print name of the lastModifiedReason field.
static boolean	getLastModifiedReasonFlag(int fieldflag) Field flag accessor.
static java.lang.String	getLastModifiedReasonInvalidValue() Invalid value for lastModifiedReason.
static int	getLastModifiedReasonLengthMax() Maximum lastModifiedReason length is 70 characters
static int	getLastModifiedReasonLengthNorm() Normal lastModifiedReason length is 30 characters
java.lang.String	getLastModifiedReasonMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getLastModifiedReasonPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getLastModifiedReasonRange() Return the range specification for this field
java.lang.String	getLastModifiedReasonValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.util.Date	getLastModifiedTime() Accessor for lastModifiedTime
static java.util.Date	getLastModifiedTimeDefaultValue() Default value for lastModifiedTime.
java.lang.String	getLastModifiedTimeFieldPrintValue() Return the print name of the lastModifiedTime field.
static boolean	getLastModifiedTimeFlag(int fieldflag) Field flag accessor.
static java.util.Date	getLastModifiedTimeInvalidValue() Invalid value for lastModifiedTime.
java.lang.String	getLastModifiedTimeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getLastModifiedTimePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getLastModifiedTimeRange() Return the range specification for this field
java.lang.String	getLastModifiedTimeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getName() Accessor for name
static java.lang.String	getNameDefaultValue() Default value for name.
java.lang.String	getNameFieldPrintValue() Return the print name of the name field.
static boolean	getNameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getNameInvalidValue() Invalid value for name.
static int	getNameLengthMax() Maximum name length is 40 characters
static int	getNameLengthNorm() Normal name length is 15 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.
long[]	getPhases() Accessor for phases
long	getPhases(int index) Returns the element at the specified index.
static long[]	getPhasesDefaultValue() Default value for phases.
static long	getPhasesElementInvalidValue() Invalid value for phaseselement.
static boolean	getPhasesFlag(int fieldflag) Field flag accessor.
static long[]	getPhasesInvalidValue() Invalid value for phases.
java.lang.String	getPhasesMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getPhasesRange() Return the range specification for this field
java.lang.String	getPhasesValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.SandQueryMessage	getQueryMessage() Returns a new TaskTypeQuery 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 TaskType 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 TaskTypeUpdate instance
java.lang.String	getValueForFieldName(java.lang.String fieldname, org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Returns the print representation of the value of the specified field, or the given default value if innaccessible.
void	init() Initialize all fields to their default values
void	insertPhases(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.
boolean	phasesContains(long val) Returns true if phases contains the specified value.
int	phasesIndexOf(long val) Return the index of the specified value in phases, or -1 if not found.
static java.lang.String	recordStatusActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	recordStatusLabelToValue(java.lang.String label) Given a label, return the value for it.
static java.lang.String	recordStatusPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	recordStatusPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	recordStatusValueToLabel(int val) Given a value, return the declared label for it.
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, org.sandev.basics.util.IDLookup idlookup, org.sandev.basics.util.NameLookup namelookup, org.sandev.basics.util.AuthUser au) Validate the references as specified in the Resolvable interface.
long	removePhases(int index) Remove the element at the specified index and return it.
boolean	removePhasesValue(long value) Removes the given element from phases.
TaskPhase[]	resolvePhasesReferences(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Converts this array of references into an array of instances, by looking them up.
TaskPhase[]	resolvePhasesReferencesNoLookup() A degenerate reference lookup that returns an array of newly allocated org.sandev.TaskHeap.sandmessages.TaskPhase instances as a standin for a real reference.
TaskPhase[]	resolvePhasesReferencesNonCrit(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Calls standard method, eating any SandException and returning an empty array.
void	setCreationTime(java.util.Date creationTime) Mutator for creationTime
void	setCreationTime(java.lang.Object creationTime) Generic mutator for creationTime
void	setDescription(java.lang.Object description) Generic mutator for description
void	setDescription(java.lang.String description) Mutator for description
void	setLastModifiedReason(java.lang.Object lastModifiedReason) Generic mutator for lastModifiedReason
void	setLastModifiedReason(java.lang.String lastModifiedReason) Mutator for lastModifiedReason
void	setLastModifiedTime(java.util.Date lastModifiedTime) Mutator for lastModifiedTime
void	setLastModifiedTime(java.lang.Object lastModifiedTime) Generic mutator for lastModifiedTime
void	setName(java.lang.Object name) Generic mutator for name
void	setName(java.lang.String name) Mutator for name
void	setPhases(int index, long value) Set the value at the index specified.
void	setPhases(long[] phases) Mutator for phases
void	setRecordStatus(int recordStatus) Mutator for recordStatus
void	setRevisionNumber(long revisionNumber) Mutator for revisionNumber
void	setUniqueID(long uniqueID) Mutator for uniqueID
int	sizeofPhases() Returns the size of phases.
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.

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

TaskType

public TaskType()

Default constructor calls init.

Method Detail

fieldHasFlag

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

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

Specified by:

fieldHasFlag in interface org.sandev.basics.structs.SandInstanceMessage

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

getNameLengthMax

public static int getNameLengthMax()

Maximum name length is 40 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_TASKTYPE_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.

getDescription

public java.lang.String getDescription()

Accessor for description

setDescription

public void setDescription(java.lang.String description)

Mutator for description

setDescription

public void setDescription(java.lang.Object description)

Generic mutator for description

getDescriptionFlag

public static boolean getDescriptionFlag(int fieldflag)

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

getDescriptionLengthNorm

public static int getDescriptionLengthNorm()

Normal description length is 512 characters

getDescriptionLengthMax

public static int getDescriptionLengthMax()

Maximum description length is 1048576 characters

getDescriptionDefaultValue

public static java.lang.String getDescriptionDefaultValue()

Default value for description. Returns ""

getDescriptionInvalidValue

public static java.lang.String getDescriptionInvalidValue()

Invalid value for description. Returns "TASKHEAP_INVALID_TASKTYPE_DESCRIPTION"

getDescriptionPrintValue

public java.lang.String getDescriptionPrintValue()

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.

getDescriptionFieldPrintValue

public java.lang.String getDescriptionFieldPrintValue()

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

getDescriptionRange

public java.lang.String getDescriptionRange()

Return the range specification for this field

getDescriptionValidityCheck

public java.lang.String getDescriptionValidityCheck()

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.

getDescriptionMetatype

public java.lang.String getDescriptionMetatype()

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

getPhases

public long[] getPhases()

Accessor for phases

setPhases

public void setPhases(long[] phases)

Mutator for phases

addPhases

public void addPhases(long element)

Appends a value to phases

addPhases

public void addPhases(long[] elements)

Appends an array of values to phases

getPhases

public long getPhases(int index)

Returns the element at the specified index. Returns null/-1 if the index was out of bounds.

setPhases

public void setPhases(int index,
                      long value)

Set the value at the index specified.

insertPhases

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

removePhases

public long removePhases(int index)

Remove the element at the specified index and return it.

removePhasesValue

public boolean removePhasesValue(long value)

Removes the given element from phases. Returns true if the element was found.

clearPhases

public void clearPhases()

Clears all values from phases

phasesContains

public boolean phasesContains(long val)

Returns true if phases contains the specified value.

phasesIndexOf

public int phasesIndexOf(long val)

Return the index of the specified value in phases, or -1 if not found.

sizeofPhases

public int sizeofPhases()

Returns the size of phases. Returns -1 if phases is null.

getPhasesFlag

public static boolean getPhasesFlag(int fieldflag)

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

getPhasesDefaultValue

public static long[] getPhasesDefaultValue()

Default value for phases. Returns new long[0]

getPhasesElementInvalidValue

public static long getPhasesElementInvalidValue()

Invalid value for phaseselement. Returns Long.MIN_VALUE

getPhasesInvalidValue

public static long[] getPhasesInvalidValue()

Invalid value for phases. Returns null

getPhasesRange

public java.lang.String getPhasesRange()

Return the range specification for this field

resolvePhasesReferencesNoLookup

public TaskPhase[] resolvePhasesReferencesNoLookup()

A degenerate reference lookup that returns an array of newly allocated org.sandev.TaskHeap.sandmessages.TaskPhase instances as a standin for a real reference.

resolvePhasesReferencesNonCrit

public TaskPhase[] resolvePhasesReferencesNonCrit(org.sandev.basics.util.IDLookup lookup,
                                                  org.sandev.basics.util.AuthUser au)

Calls standard method, eating any SandException and returning an empty array. This is to support the UI, which is basically calling to get detail for a richer display. If the detail is not available, it's not critical (hence the name).

resolvePhasesReferences

public TaskPhase[] resolvePhasesReferences(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 them up.

Throws:

org.sandev.basics.structs.SandException

getPhasesValidityCheck

public java.lang.String getPhasesValidityCheck()

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.

getPhasesMetatype

public java.lang.String getPhasesMetatype()

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

getUniqueID

public long getUniqueID()

Accessor for uniqueID

Specified by:

getUniqueID in interface org.sandev.basics.structs.SandPersistMessage

setUniqueID

public void setUniqueID(long uniqueID)

Mutator for uniqueID

Specified by:

setUniqueID in interface org.sandev.basics.structs.SandPersistMessage

getUniqueIDFlag

public static boolean getUniqueIDFlag(int fieldflag)

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

getUniqueIDDefaultValue

public static long getUniqueIDDefaultValue()

Default value for uniqueID. Returns 0

getUniqueIDInvalidValue

public static long getUniqueIDInvalidValue()

Invalid value for uniqueID. Returns Long.MIN_VALUE

getUniqueIDPrintValue

public java.lang.String getUniqueIDPrintValue()

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.structs.SandPersistMessage

setCreationTime

public void setCreationTime(java.util.Date creationTime)

Mutator for creationTime

setCreationTime

public void setCreationTime(java.lang.Object creationTime)

Generic mutator for creationTime

getCreationTimeFlag

public static boolean getCreationTimeFlag(int fieldflag)

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

getCreationTimeDefaultValue

public static java.util.Date getCreationTimeDefaultValue()

Default value for creationTime. Returns System.currentTimeMillis()

getCreationTimeInvalidValue

public static java.util.Date getCreationTimeInvalidValue()

Invalid value for creationTime. Returns null

getCreationTimePrintValue

public java.lang.String getCreationTimePrintValue()

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

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.structs.SandPersistMessage

setLastModifiedTime

public void setLastModifiedTime(java.util.Date lastModifiedTime)

Mutator for lastModifiedTime

setLastModifiedTime

public void setLastModifiedTime(java.lang.Object lastModifiedTime)

Generic mutator for lastModifiedTime

getLastModifiedTimeFlag

public static boolean getLastModifiedTimeFlag(int fieldflag)

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

getLastModifiedTimeDefaultValue

public static java.util.Date getLastModifiedTimeDefaultValue()

Default value for lastModifiedTime. Returns System.currentTimeMillis()

getLastModifiedTimeInvalidValue

public static java.util.Date getLastModifiedTimeInvalidValue()

Invalid value for lastModifiedTime. Returns null

getLastModifiedTimePrintValue

public java.lang.String getLastModifiedTimePrintValue()

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

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.structs.SandPersistMessage

setLastModifiedReason

public void setLastModifiedReason(java.lang.String lastModifiedReason)

Mutator for lastModifiedReason

Specified by:

setLastModifiedReason in interface org.sandev.basics.structs.SandPersistMessage

setLastModifiedReason

public void setLastModifiedReason(java.lang.Object lastModifiedReason)

Generic mutator for lastModifiedReason

getLastModifiedReasonFlag

public static boolean getLastModifiedReasonFlag(int fieldflag)

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

getLastModifiedReasonLengthNorm

public static int getLastModifiedReasonLengthNorm()

Normal lastModifiedReason length is 30 characters

getLastModifiedReasonLengthMax

public static int getLastModifiedReasonLengthMax()

Maximum lastModifiedReason length is 70 characters

getLastModifiedReasonDefaultValue

public static java.lang.String getLastModifiedReasonDefaultValue()

Default value for lastModifiedReason. Returns ""

getLastModifiedReasonInvalidValue

public static java.lang.String getLastModifiedReasonInvalidValue()

Invalid value for lastModifiedReason. Returns null

getLastModifiedReasonPrintValue

public java.lang.String getLastModifiedReasonPrintValue()

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.structs.SandPersistMessage

setRevisionNumber

public void setRevisionNumber(long revisionNumber)

Mutator for revisionNumber

Specified by:

setRevisionNumber in interface org.sandev.basics.structs.SandPersistMessage

getRevisionNumberFlag

public static boolean getRevisionNumberFlag(int fieldflag)

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

getRevisionNumberDefaultValue

public static long getRevisionNumberDefaultValue()

Default value for revisionNumber. Returns 0

getRevisionNumberInvalidValue

public static long getRevisionNumberInvalidValue()

Invalid value for revisionNumber. Returns Long.MIN_VALUE

getRevisionNumberPrintValue

public java.lang.String getRevisionNumberPrintValue()

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.

getRecordStatus

public int getRecordStatus()

Accessor for recordStatus

Specified by:

getRecordStatus in interface org.sandev.basics.structs.SandPersistMessage

setRecordStatus

public void setRecordStatus(int recordStatus)

Mutator for recordStatus

recordStatusValueToLabel

public java.lang.String recordStatusValueToLabel(int val)

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.

recordStatusLabelToValue

public int recordStatusLabelToValue(java.lang.String label)

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

getRecordStatusPrintVals

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

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.

<