org.sandev.TaskHeap.sandmessages
Class PlanComponent

java.lang.Object
  org.sandev.TaskHeap.structs.PlanComponentStruct
      org.sandev.TaskHeap.sandmessages.PlanComponent

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 PlanComponent

extends PlanComponentStruct

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.PlanComponentStruct
generator: org.sandev.generator.MessageClassGenerator
time: Dec 2, 2005 6:38:51 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.PlanComponentStruct

description, dueDate, name, notes, parent, resourceID, timeEstimate

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

PlanComponent()
Default constructor calls init.

Method Summary

void	addNotes(Note element) Appends a value to notes
void	addNotes(Note[] elements) Appends an array of values to notes
void	clearNotes() Clears all values from notes
org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls clonePlanComponent
PlanComponent	clonePlanComponent() Make a deep copy of this PlanComponent.
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(PlanComponent 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 PlanComponentCollection 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.util.Date	getDueDate() Accessor for dueDate
static java.util.Date	getDueDateDefaultValue() Default value for dueDate.
java.lang.String	getDueDateFieldPrintValue() Return the print name of the dueDate field.
static boolean	getDueDateFlag(int fieldflag) Field flag accessor.
static java.util.Date	getDueDateInvalidValue() Invalid value for dueDate.
java.lang.String	getDueDateMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getDueDatePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDueDateRange() Return the range specification for this field
java.lang.String	getDueDateValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getLastModifiedReason() Accessor for lastModifiedReason
static java.lang.String	getLastModifiedReasonDefaultValue() Default value for lastModifiedReason.
java.lang.String	getLastModifiedReasonFieldPrintValue() Return the print name of the lastModifiedReason field.
static boolean	getLastModifiedReasonFlag(int fieldflag) Field flag accessor.
static java.lang.String	getLastModifiedReasonInvalidValue() Invalid value for lastModifiedReason.
static int	getLastModifiedReasonLengthMax() Maximum lastModifiedReason length is 70 characters
static int	getLastModifiedReasonLengthNorm() Normal lastModifiedReason length is 30 characters
java.lang.String	getLastModifiedReasonMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getLastModifiedReasonPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getLastModifiedReasonRange() Return the range specification for this field
java.lang.String	getLastModifiedReasonValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.util.Date	getLastModifiedTime() Accessor for lastModifiedTime
static java.util.Date	getLastModifiedTimeDefaultValue() Default value for lastModifiedTime.
java.lang.String	getLastModifiedTimeFieldPrintValue() Return the print name of the lastModifiedTime field.
static boolean	getLastModifiedTimeFlag(int fieldflag) Field flag accessor.
static java.util.Date	getLastModifiedTimeInvalidValue() Invalid value for lastModifiedTime.
java.lang.String	getLastModifiedTimeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getLastModifiedTimePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getLastModifiedTimeRange() Return the range specification for this field
java.lang.String	getLastModifiedTimeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getName() Accessor for name
static java.lang.String	getNameDefaultValue() Default value for name.
java.lang.String	getNameFieldPrintValue() Return the print name of the name field.
static boolean	getNameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getNameInvalidValue() Invalid value for name.
static int	getNameLengthMax() Maximum name length is 80 characters
static int	getNameLengthNorm() Normal name length is 30 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.
Note[]	getNotes() Accessor for notes
Note	getNotes(int index) Returns the element at the specified index.
static Note[]	getNotesDefaultValue() Default value for notes.
static Note	getNotesElementInvalidValue() Invalid value for noteselement.
static boolean	getNotesFlag(int fieldflag) Field flag accessor.
static Note[]	getNotesInvalidValue() Invalid value for notes.
static int	getNotesLengthMax() Maximum notes length is 1048576 characters
static int	getNotesLengthNorm() Normal notes length is 512 characters
java.lang.String	getNotesMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getNotesRange() Return the range specification for this field
java.lang.String	getNotesValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
long	getParent() Accessor for parent
static long	getParentDefaultValue() Default value for parent.
java.lang.String	getParentFieldPrintValue() Return the print name of the parent field.
static boolean	getParentFlag(int fieldflag) Field flag accessor.
static long	getParentInvalidValue() Invalid value for parent.
java.lang.String	getParentMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getParentPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getParentRange() Return the range specification for this field
java.lang.String	getParentValidityCheck() 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 PlanComponentQuery 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	getResourceID() Accessor for resourceID
static long	getResourceIDDefaultValue() Default value for resourceID.
java.lang.String	getResourceIDFieldPrintValue() Return the print name of the resourceID field.
static boolean	getResourceIDFlag(int fieldflag) Field flag accessor.
static long	getResourceIDInvalidValue() Invalid value for resourceID.
java.lang.String	getResourceIDMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getResourceIDPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getResourceIDRange() Return the range specification for this field
java.lang.String	getResourceIDValidityCheck() 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 PlanComponent instance
long	getTimeEstimate() Accessor for timeEstimate
static long	getTimeEstimateDefaultValue() Default value for timeEstimate.
java.lang.String	getTimeEstimateFieldPrintValue() Return the print name of the timeEstimate field.
static boolean	getTimeEstimateFlag(int fieldflag) Field flag accessor.
static long	getTimeEstimateInvalidValue() Invalid value for timeEstimate.
java.lang.String	getTimeEstimateMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getTimeEstimatePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getTimeEstimateRange() Return the range specification for this field
java.lang.String	getTimeEstimateValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
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 PlanComponentUpdate 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	insertNotes(int index, Note 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	notesContains(Note val) Returns true if notes contains the specified value.
int	notesIndexOf(Note val) Return the index of the specified value in notes, 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.
Note	removeNotes(int index) Remove the element at the specified index and return it.
boolean	removeNotesValue(Note value) Removes the given element from notes.
Plan	resolveParentReference(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Converts a reference to an instance by looking it up.
Plan	resolveParentReferenceNonCrit(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.
Resource	resolveResourceIDReference(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Converts a reference to an instance by looking it up.
Resource	resolveResourceIDReferenceNonCrit(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.
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	setDueDate(java.util.Date dueDate) Mutator for dueDate
void	setDueDate(java.lang.Object dueDate) Generic mutator for dueDate
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	setNotes(int index, Note value) Set the value at the index specified.
void	setNotes(Note[] notes) Mutator for notes
void	setNotes(java.lang.Object[] notes) Generic mutator for notes
void	setParent(long parent) Mutator for parent
void	setRecordStatus(int recordStatus) Mutator for recordStatus
void	setResourceID(long resourceID) Mutator for resourceID
void	setRevisionNumber(long revisionNumber) Mutator for revisionNumber
void	setTimeEstimate(long timeEstimate) Mutator for timeEstimate
void	setUniqueID(long uniqueID) Mutator for uniqueID
int	sizeofNotes() Returns the size of notes.
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

PlanComponent

public PlanComponent()

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

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

getParent

public long getParent()

Accessor for parent

setParent

public void setParent(long parent)

Mutator for parent

getParentFlag

public static boolean getParentFlag(int fieldflag)

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

getParentDefaultValue

public static long getParentDefaultValue()

Default value for parent. Returns 0

getParentInvalidValue

public static long getParentInvalidValue()

Invalid value for parent. Returns Long.MIN_VALUE

getParentPrintValue

public java.lang.String getParentPrintValue()

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.

getParentFieldPrintValue

public java.lang.String getParentFieldPrintValue()

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

getParentRange

public java.lang.String getParentRange()

Return the range specification for this field

resolveParentReferenceNonCrit

public Plan resolveParentReferenceNonCrit(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).

resolveParentReference

public Plan resolveParentReference(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

getParentValidityCheck

public java.lang.String getParentValidityCheck()

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.

getParentMetatype

public java.lang.String getParentMetatype()

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

getResourceID

public long getResourceID()

Accessor for resourceID

setResourceID

public void setResourceID(long resourceID)

Mutator for resourceID

getResourceIDFlag

public static boolean getResourceIDFlag(int fieldflag)

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

getResourceIDDefaultValue

public static long getResourceIDDefaultValue()

Default value for resourceID. Returns 0

getResourceIDInvalidValue

public static long getResourceIDInvalidValue()

Invalid value for resourceID. Returns Long.MIN_VALUE

getResourceIDPrintValue

public java.lang.String getResourceIDPrintValue()

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.

getResourceIDFieldPrintValue

public java.lang.String getResourceIDFieldPrintValue()

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

getResourceIDRange

public java.lang.String getResourceIDRange()

Return the range specification for this field

resolveResourceIDReferenceNonCrit

public Resource resolveResourceIDReferenceNonCrit(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).

resolveResourceIDReference

public Resource resolveResourceIDReference(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

getResourceIDValidityCheck

public java.lang.String getResourceIDValidityCheck()

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.

getResourceIDMetatype

public java.lang.String getResourceIDMetatype()

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

getTimeEstimate

public long getTimeEstimate()

Accessor for timeEstimate

setTimeEstimate

public void setTimeEstimate(long timeEstimate)

Mutator for timeEstimate

getTimeEstimateFlag

public static boolean getTimeEstimateFlag(int fieldflag)

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

getTimeEstimateDefaultValue

public static long getTimeEstimateDefaultValue()

Default value for timeEstimate. Returns 0

getTimeEstimateInvalidValue

public static long getTimeEstimateInvalidValue()

Invalid value for timeEstimate. Returns Long.MIN_VALUE

getTimeEstimatePrintValue

public java.lang.String getTimeEstimatePrintValue()

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.

getTimeEstimateFieldPrintValue

public java.lang.String getTimeEstimateFieldPrintValue()

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

getTimeEstimateRange

public java.lang.String getTimeEstimateRange()

Return the range specification for this field

getTimeEstimateValidityCheck

public java.lang.String getTimeEstimateValidityCheck()

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.

getTimeEstimateMetatype

public java.lang.String getTimeEstimateMetatype()

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

getDueDate

public java.util.Date getDueDate()

Accessor for dueDate