org.sandev.TaskHeap.sandmessages
Class TaskType

java.lang.Object
  extended by org.sandev.TaskHeap.structs.TaskTypeStruct
      extended by org.sandev.TaskHeap.sandmessages.TaskType
All Implemented Interfaces:
org.sandev.basics.structs.SandInstanceMessage, org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandPersistMessage, org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable

public class 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: Jul 31, 2008 4:34:16 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.TaskTypeStruct
description, heap, name, phases
 
Fields inherited from interface org.sandev.basics.structs.SandPersistMessage
WRITEACCESS_NORMAL, WRITEACCESS_READONLY
 
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, 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.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 TaskTypeCollection instance
 java.lang.String[] getContainedMessageFields()
          Return an array of all contained message fields.
 java.util.Date getCreationTime()
          Accessor for creationTime
static java.util.Date getCreationTimeDefaultValue()
          Default value for creationTime.
 java.lang.String getCreationTimeFieldPrintValue()
          Return the print name of the creationTime field.
static boolean getCreationTimeFlag(int fieldflag)
          Field flag accessor.
static java.util.Date getCreationTimeInvalidValue()
          Invalid value for creationTime.
 java.lang.String getCreationTimeMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getCreationTimePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getCreationTimeRange()
          Return the range specification for this field
 java.lang.String getCreationTimeValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.util.Date getCreationTimeWithOffset()
          Return the date value incorporating the timezone offset specified for the field, if any.
 java.lang.String 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[] 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.
 long getHeap()
          Accessor for heap
static long getHeapDefaultValue()
          Default value for heap.
 java.lang.String getHeapFieldPrintValue()
          Return the print name of the heap field.
static boolean getHeapFlag(int fieldflag)
          Field flag accessor.
static long getHeapInvalidValue()
          Invalid value for heap.
 java.lang.String getHeapMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getHeapPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getHeapRange()
          Return the range specification for this field
 java.lang.String getHeapValidityCheck()
          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 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.
 java.lang.String getPhasesFieldPrintValue()
          Return the print name of the phases field.
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 getPhasesPrintValue()
          Retrieve the current value of this field as a print String.
 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.
 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 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 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 removePhases(int index)
          Remove the element at the specified index and return it.
 boolean removePhasesValue(long value)
          Removes the given element from phases.
 HeapAttributes resolveHeapReference(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au)
          Converts a reference to an instance by looking it up.
 HeapAttributes resolveHeapReferenceNonCrit(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au)
          Calls standard method, eating any SandException and returning a new instance uniqueID -1.
 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 up each reference ID.
 TaskPhase[] resolvePhasesReferences(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.
 TaskPhase[] resolvePhasesReferences(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.
 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)
          Resolve the array of reference IDs into an array of instances, without throwing an exception if a given ID cannot be resolved.
 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 setDescription(java.lang.Object description)
          Generic mutator for description
 void setDescription(java.lang.String description)
          Mutator for description
 void setHeap(long heap)
          Mutator for heap
 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 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
 TaskType shallowCopy()
          Make a shallow copy of this TaskType.
 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.


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

TaskType

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

getHeap

public long getHeap()
Accessor for heap


setHeap

public void setHeap(long heap)
Mutator for heap


getHeapFlag

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


getHeapDefaultValue

public static long getHeapDefaultValue()
Default value for heap. Returns 0


getHeapInvalidValue

public static long getHeapInvalidValue()
Invalid value for heap. Returns Long.MIN_VALUE


getHeapPrintValue

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


getHeapFieldPrintValue

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


getHeapRange

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


resolveHeapReferenceNonCrit

public HeapAttributes resolveHeapReferenceNonCrit(org.sandev.basics.util.IDLookup lookup,
                                                  org.sandev.basics.util.AuthUser au)
Calls standard method, eating any SandException and returning a new instance uniqueID -1. 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).


resolveHeapReference

public HeapAttributes resolveHeapReference(org.sandev.basics.util.IDLookup lookup,
                                           org.sandev.basics.util.AuthUser au)
                                    throws org.sandev.basics.structs.SandException
Converts a reference to an instance by looking it up.

Throws:
org.sandev.basics.structs.SandException

getHeapValidityCheck

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


getHeapMetatype

public java.lang.String getHeapMetatype()
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 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. The returned value may or may not be the actual data member. Always write back a changed array using setPhases.


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 -1 if phases is null or smaller than index.


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


getPhasesPrintValue

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


getPhasesFieldPrintValue

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


getPhasesRange

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


resolvePhasesReferencesNoLookup

public TaskPhase[] resolvePhasesReferencesNoLookup()
A degen