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.structs.SandInstanceMessage, org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandPersistMessage, org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable, PlanComponentInterface

public class PlanComponent
extends PlanComponentStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable, org.sandev.basics.structs.SandPersistMessage, PlanComponentInterface

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.structs.PlanComponentStruct
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.
static int	DUEDELTASENSE_AFTER Possible value for dueDeltaSense
static int	DUEDELTASENSE_BEFORE Possible value for dueDeltaSense
static int	DUETIMEUNITS_DAYS Possible value for dueTimeUnits
static int	DUETIMEUNITS_HOURS Possible value for dueTimeUnits
static int	DUETIMEUNITS_WEEKS Possible value for dueTimeUnits
static int	DUETYPE_FIXED Possible value for dueType
static int	DUETYPE_NONE Possible value for dueType
static int	DUETYPE_RELATIVE Possible value for dueType
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
static int	RELROUNDDAY_FRIDAY Possible value for relRoundDay
static int	RELROUNDDAY_MONDAY Possible value for relRoundDay
static int	RELROUNDDAY_SATURDAY Possible value for relRoundDay
static int	RELROUNDDAY_SUNDAY Possible value for relRoundDay
static int	RELROUNDDAY_THURSDAY Possible value for relRoundDay
static int	RELROUNDDAY_TUESDAY Possible value for relRoundDay
static int	RELROUNDDAY_WEDNESDAY Possible value for relRoundDay
static int	RELROUNDING_EXACT Possible value for relRounding
static int	RELROUNDING_FOLLOWING Possible value for relRounding
static int	RELROUNDING_MIDMONTH Possible value for relRounding
static int	RELROUNDING_NEAREST Possible value for relRounding
static int	RELROUNDING_PRECEDING Possible value for relRounding
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

assignedTo, description, dueDate, dueDelta, dueDeltaSense, dueDeltaValue, dueReference, dueTimeUnits, dueType, heap, name, notes, parent, relRoundDay, relRounding, responsibilities, timeEstimate

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	addResponsibilities(long element) Appends a value to responsibilities
void	addResponsibilities(long[] elements) Appends an array of values to responsibilities
void	clearNotes() Clears all values from notes
void	clearResponsibilities() Clears all values from responsibilities
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, 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.
static java.lang.String	dueDeltaSenseActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	dueDeltaSenseLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	dueDeltaSenseLabelToValueStatic(java.lang.String label)
static java.lang.String	dueDeltaSensePrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	dueDeltaSensePrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	dueDeltaSenseValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	dueDeltaSenseValueToLabelStatic(int val)
static java.lang.String	dueTimeUnitsActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	dueTimeUnitsLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	dueTimeUnitsLabelToValueStatic(java.lang.String label)
static java.lang.String	dueTimeUnitsPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	dueTimeUnitsPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	dueTimeUnitsValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	dueTimeUnitsValueToLabelStatic(int val)
static java.lang.String	dueTypeActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	dueTypeLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	dueTypeLabelToValueStatic(java.lang.String label)
static java.lang.String	dueTypePrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	dueTypePrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	dueTypeValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	dueTypeValueToLabelStatic(int val)
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.
long	getAssignedTo() Accessor for assignedTo
static long	getAssignedToDefaultValue() Default value for assignedTo.
java.lang.String	getAssignedToFieldPrintValue() Return the print name of the assignedTo field.
static boolean	getAssignedToFlag(int fieldflag) Field flag accessor.
static long	getAssignedToInvalidValue() Invalid value for assignedTo.
java.lang.String	getAssignedToMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getAssignedToPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getAssignedToRange() Return the range specification for this field
java.lang.String	getAssignedToValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getBaseMemoryUse() Return the base memory use for this object.
org.sandev.basics.structs.SandCollectionMessage	getCollectionMessage() Returns a new PlanComponentCollection 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.
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.util.Date	getDueDateWithOffset() Return the date value incorporating the timezone offset specified for the field, if any.
int	getDueDelta() Accessor for dueDelta
static int	getDueDeltaDefaultValue() Default value for dueDelta.
java.lang.String	getDueDeltaFieldPrintValue() Return the print name of the dueDelta field.
static boolean	getDueDeltaFlag(int fieldflag) Field flag accessor.
static int	getDueDeltaInvalidValue() Invalid value for dueDelta.
java.lang.String	getDueDeltaMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getDueDeltaPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDueDeltaRange() Return the range specification for this field
int	getDueDeltaSense() Accessor for dueDeltaSense
static java.lang.String[]	getDueDeltaSenseActualVals() Return an array of the possible values for this field as Strings.
static int	getDueDeltaSenseDefaultValue() Default value for dueDeltaSense.
static java.lang.String	getDueDeltaSenseEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getDueDeltaSenseFieldPrintValue() Return the print name of the dueDeltaSense field.
static boolean	getDueDeltaSenseFlag(int fieldflag) Field flag accessor.
static int	getDueDeltaSenseInvalidValue() Invalid value for dueDeltaSense.
static java.lang.String[]	getDueDeltaSenseKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getDueDeltaSenseMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getDueDeltaSensePrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getDueDeltaSensePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDueDeltaSenseRange() Return the range specification for this field
java.lang.String	getDueDeltaSenseValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getDueDeltaValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getDueDeltaValue() Accessor for dueDeltaValue
static int	getDueDeltaValueDefaultValue() Default value for dueDeltaValue.
java.lang.String	getDueDeltaValueFieldPrintValue() Return the print name of the dueDeltaValue field.
static boolean	getDueDeltaValueFlag(int fieldflag) Field flag accessor.
static int	getDueDeltaValueInvalidValue() Invalid value for dueDeltaValue.
java.lang.String	getDueDeltaValueMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getDueDeltaValuePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDueDeltaValueRange() Return the range specification for this field
java.lang.String	getDueDeltaValueValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
long	getDueReference() Accessor for dueReference
static long	getDueReferenceDefaultValue() Default value for dueReference.
java.lang.String	getDueReferenceFieldPrintValue() Return the print name of the dueReference field.
static boolean	getDueReferenceFlag(int fieldflag) Field flag accessor.
static long	getDueReferenceInvalidValue() Invalid value for dueReference.
java.lang.String	getDueReferenceMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getDueReferencePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDueReferenceRange() Return the range specification for this field
java.lang.String	getDueReferenceValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getDueTimeUnits() Accessor for dueTimeUnits
static java.lang.String[]	getDueTimeUnitsActualVals() Return an array of the possible values for this field as Strings.
static int	getDueTimeUnitsDefaultValue() Default value for dueTimeUnits.
static java.lang.String	getDueTimeUnitsEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getDueTimeUnitsFieldPrintValue() Return the print name of the dueTimeUnits field.
static boolean	getDueTimeUnitsFlag(int fieldflag) Field flag accessor.
static int	getDueTimeUnitsInvalidValue() Invalid value for dueTimeUnits.
static java.lang.String[]	getDueTimeUnitsKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getDueTimeUnitsMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getDueTimeUnitsPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getDueTimeUnitsPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDueTimeUnitsRange() Return the range specification for this field
java.lang.String	getDueTimeUnitsValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getDueType() Accessor for dueType
static java.lang.String[]	getDueTypeActualVals() Return an array of the possible values for this field as Strings.
static int	getDueTypeDefaultValue() Default value for dueType.
static java.lang.String	getDueTypeEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getDueTypeFieldPrintValue() Return the print name of the dueType field.
static boolean	getDueTypeFlag(int fieldflag) Field flag accessor.
static int	getDueTypeInvalidValue() Invalid value for dueType.
static java.lang.String[]	getDueTypeKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getDueTypeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getDueTypePrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getDueTypePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDueTypeRange() Return the range specification for this field
java.lang.String	getDueTypeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
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 128 characters
static int	getNameLengthNorm() Normal name length is 60 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.
java.lang.String	getNotesFieldPrintValue() Return the print name of the notes field.
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	getNotesPrintValue() Retrieve the current value of this field as a print String.
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.
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 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.
int	getRelRoundDay() Accessor for relRoundDay
static java.lang.String[]	getRelRoundDayActualVals() Return an array of the possible values for this field as Strings.
static int	getRelRoundDayDefaultValue() Default value for relRoundDay.
static java.lang.String	getRelRoundDayEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getRelRoundDayFieldPrintValue() Return the print name of the relRoundDay field.
static boolean	getRelRoundDayFlag(int fieldflag) Field flag accessor.
static int	getRelRoundDayInvalidValue() Invalid value for relRoundDay.
static java.lang.String[]	getRelRoundDayKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getRelRoundDayMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getRelRoundDayPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getRelRoundDayPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getRelRoundDayRange() Return the range specification for this field
java.lang.String	getRelRoundDayValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getRelRounding() Accessor for relRounding
static java.lang.String[]	getRelRoundingActualVals() Return an array of the possible values for this field as Strings.
static int	getRelRoundingDefaultValue() Default value for relRounding.
static java.lang.String	getRelRoundingEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getRelRoundingFieldPrintValue() Return the print name of the relRounding field.
static boolean	getRelRoundingFlag(int fieldflag) Field flag accessor.
static int	getRelRoundingInvalidValue() Invalid value for relRounding.
static java.lang.String[]	getRelRoundingKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getRelRoundingMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getRelRoundingPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getRelRoundingPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getRelRoundingRange() Return the range specification for this field
java.lang.String	getRelRoundingValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
long[]	getResponsibilities() Accessor for responsibilities.
long	getResponsibilities(int index) Returns the element at the specified index.
static long[]	getResponsibilitiesDefaultValue() Default value for responsibilities.
static long	getResponsibilitiesElementInvalidValue() Invalid value for responsibilitieselement.
java.lang.String	getResponsibilitiesFieldPrintValue() Return the print name of the responsibilities field.
static boolean	getResponsibilitiesFlag(int fieldflag) Field flag accessor.
static long[]	getResponsibilitiesInvalidValue() Invalid value for responsibilities.
java.lang.String	getResponsibilitiesMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getResponsibilitiesPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getResponsibilitiesRange() Return the range specification for this field
java.lang.String	getResponsibilitiesValidityCheck() 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
int	getTimeEstimate() Accessor for timeEstimate
static int	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 int	getTimeEstimateInvalidValue() Invalid value for timeEstimate.
static int	getTimeEstimateLengthMax() Maximum timeEstimate length is 20 characters
static int	getTimeEstimateLengthNorm() Normal timeEstimate length is 3 characters
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.
void	insertResponsibilities(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	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 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.
static java.lang.String	relRoundDayActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	relRoundDayLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	relRoundDayLabelToValueStatic(java.lang.String label)
static java.lang.String	relRoundDayPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	relRoundDayPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	relRoundDayValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	relRoundDayValueToLabelStatic(int val)
static java.lang.String	relRoundingActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	relRoundingLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	relRoundingLabelToValueStatic(java.lang.String label)
static java.lang.String	relRoundingPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	relRoundingPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	relRoundingValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	relRoundingValueToLabelStatic(int val)
Note	removeNotes(int index) Remove the element at the specified index and return it.
boolean	removeNotesValue(Note value) Removes the given element from notes.
long	removeResponsibilities(int index) Remove the element at the specified index and return it.
boolean	removeResponsibilitiesValue(long value) Removes the given element from responsibilities.
HeapAssociation	resolveAssignedToReference(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Converts a reference to an instance by looking it up.
HeapAssociation	resolveAssignedToReferenceNonCrit(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.
Plan	resolveDueReferenceReference(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Converts a reference to an instance by looking it up.
Plan	resolveDueReferenceReferenceNonCrit(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.
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.
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.
Role[]	resolveResponsibilitiesReferences(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.
Role[]	resolveResponsibilitiesReferences(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.
Role[]	resolveResponsibilitiesReferences(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.
Role[]	resolveResponsibilitiesReferencesNoLookup() A degenerate reference lookup that returns an array of newly allocated org.sandev.TaskHeap.sandmessages.Role instances as a standin for a real reference.
Role[]	resolveResponsibilitiesReferencesNonCrit(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.
boolean	responsibilitiesContains(long val) Returns true if responsibilities contains the specified value.
int	responsibilitiesIndexOf(long val) Return the index of the specified value in responsibilities, or -1 if not found.
void	setAssignedTo(long assignedTo) Mutator for assignedTo
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	setDueDate(java.util.Date dueDate) Mutator for dueDate
void	setDueDate(java.lang.Object dueDate) Generic mutator for dueDate
void	setDueDateWithOffset(java.util.Date val) Set the date value incorporating the timezone offset specified for the field, if any.
void	setDueDelta(int dueDelta) Mutator for dueDelta
void	setDueDeltaSense(int dueDeltaSense) Mutator for dueDeltaSense
void	setDueDeltaValue(int dueDeltaValue) Mutator for dueDeltaValue
void	setDueReference(long dueReference) Mutator for dueReference
void	setDueTimeUnits(int dueTimeUnits) Mutator for dueTimeUnits
void	setDueType(int dueType) Mutator for dueType
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	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	setRelRoundDay(int relRoundDay) Mutator for relRoundDay
void	setRelRounding(int relRounding) Mutator for relRounding
void	setResponsibilities(int index, long value) Set the value at the index specified.
void	setResponsibilities(long[] responsibilities) Mutator for responsibilities
void	setRevisionNumber(long revisionNumber) Mutator for revisionNumber
void	setTimeEstimate(int timeEstimate) Mutator for timeEstimate
void	setUniqueID(long uniqueID) Mutator for uniqueID
PlanComponent	shallowCopy() Make a shallow copy of this PlanComponent.
int	sizeofNotes() Returns the size of notes.
int	sizeofResponsibilities() Returns the size of responsibilities.
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

DUETYPE_NONE

public static final int DUETYPE_NONE

Possible value for dueType

See Also:

Constant Field Values

DUETYPE_FIXED

public static final int DUETYPE_FIXED

Possible value for dueType

See Also:

Constant Field Values

DUETYPE_RELATIVE

public static final int DUETYPE_RELATIVE

Possible value for dueType

See Also:

Constant Field Values

DUEDELTASENSE_BEFORE

public static final int DUEDELTASENSE_BEFORE

Possible value for dueDeltaSense

See Also:

Constant Field Values

DUEDELTASENSE_AFTER

public static final int DUEDELTASENSE_AFTER

Possible value for dueDeltaSense

See Also:

Constant Field Values

DUETIMEUNITS_HOURS

public static final int DUETIMEUNITS_HOURS

Possible value for dueTimeUnits

See Also:

Constant Field Values

DUETIMEUNITS_DAYS

public static final int DUETIMEUNITS_DAYS

Possible value for dueTimeUnits

See Also:

Constant Field Values

DUETIMEUNITS_WEEKS

public static final int DUETIMEUNITS_WEEKS

Possible value for dueTimeUnits

See Also:

Constant Field Values

RELROUNDING_EXACT

public static final int RELROUNDING_EXACT

Possible value for relRounding

See Also:

Constant Field Values

RELROUNDING_NEAREST

public static final int RELROUNDING_NEAREST

Possible value for relRounding

See Also:

Constant Field Values

RELROUNDING_PRECEDING

public static final int RELROUNDING_PRECEDING

Possible value for relRounding

See Also:

Constant Field Values

RELROUNDING_FOLLOWING

public static final int RELROUNDING_FOLLOWING

Possible value for relRounding

See Also:

Constant Field Values

RELROUNDING_MIDMONTH

public static final int RELROUNDING_MIDMONTH

Possible value for relRounding

See Also:

Constant Field Values

RELROUNDDAY_MONDAY

public static final int RELROUNDDAY_MONDAY

Possible value for relRoundDay

See Also:

Constant Field Values

RELROUNDDAY_TUESDAY

public static final int RELROUNDDAY_TUESDAY

Possible value for relRoundDay

See Also:

Constant Field Values

RELROUNDDAY_WEDNESDAY

public static final int RELROUNDDAY_WEDNESDAY

Possible value for relRoundDay

See Also:

Constant Field Values

RELROUNDDAY_THURSDAY

public static final int RELROUNDDAY_THURSDAY

Possible value for relRoundDay

See Also:

Constant Field Values

RELROUNDDAY_FRIDAY

public static final int RELROUNDDAY_FRIDAY

Possible value for relRoundDay

See Also:

Constant Field Values

RELROUNDDAY_SATURDAY

public static final int RELROUNDDAY_SATURDAY

Possible value for relRoundDay

See Also:

Constant Field Values

RELROUNDDAY_SUNDAY

public static final int RELROUNDDAY_SUNDAY

Possible value for relRoundDay

See Also:

Constant Field Values

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

PlanComponent

public PlanComponent()

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

getName

public java.lang.String getName()

Accessor for name

Specified by:

getName in interface PlanComponentInterface

setName

public void setName(java.lang.String name)

Mutator for name

Specified by:

setName in interface PlanComponentInterface

setName

public void setName(java.lang.Object name)

Generic mutator for name

Specified by:

setName in interface PlanComponentInterface

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

getNameLengthMax

public static int getNameLengthMax()

Maximum name length is 128 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

Specified by:

getDescription in interface PlanComponentInterface

setDescription

public void setDescription(java.lang.String description)

Mutator for description

Specified by:

setDescription in interface PlanComponentInterface

setDescription

public void setDescription(java.lang.Object description)

Generic mutator for description

Specified by:

setDescription in interface PlanComponentInterface

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

Specified by:

getParent in interface PlanComponentInterface

setParent

public void setParent(long parent)

Mutator for parent

Specified by:

setParent in interface PlanComponentInterface

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.

getHeap

public long getHeap()

Accessor for heap

Specified by:

getHeap in interface PlanComponentInterface

setHeap

public void setHeap(long heap)

Mutator for heap

Specified by:

setHeap in interface PlanComponentInterface

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.

getTimeEstimate

public int getTimeEstimate()

Accessor for timeEstimate

Specified by:

getTimeEstimate in interface PlanComponentInterface

setTimeEstimate

public void setTimeEstimate(int timeEstimate)

Mutator for timeEstimate

Specified by:

setTimeEstimate in interface PlanComponentInterface

getTimeEstimateFlag

public static boolean getTimeEstimateFlag(int fieldflag)

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

getTimeEstimateLengthNorm

public static int getTimeEstimateLengthNorm()

Normal timeEstimate length is 3 characters

getTimeEstimateLengthMax

public static int getTimeEstimateLengthMax()

Maximum timeEstimate length is 20 characters

getTimeEstimateDefaultValue

public static int getTimeEstimateDefaultValue()

Default value for timeEstimate. Returns 0

getTimeEstimateInvalidValue

public static int getTimeEstimateInvalidValue()

Invalid value for timeEstimate. Returns Integer.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.

getResponsibilities

public long[] getResponsibilities()

Accessor for responsibilities. The returned value may or may not be the actual data member. Always write back a changed array using setResponsibilities.

Specified by:

getResponsibilities in interface PlanComponentInterface

setResponsibilities

public void setResponsibilities(long[] responsibilities)

Mutator for responsibilities

Specified by:

setResponsibilities in interface PlanComponentInterface

addResponsibilities

public void addResponsibilities(long element)

Appends a value to responsibilities

Specified by:

addResponsibilities in interface PlanComponentInterface

addResponsibilities

public void addResponsibilities(long[] elements)

Appends an array of values to responsibilities

Specified by:

addResponsibilities in interface PlanComponentInterface

getResponsibilities

public long getResponsibilities(int index)

Returns the element at the specified index. Returns -1 if responsibilities is null or smaller than index.

Specified by:

getResponsibilities in interface PlanComponentInterface

setResponsibilities

public void setResponsibilities(int index,
                                long value)

Set the value at the index specified.

Specified by:

setResponsibilities in interface PlanComponentInterface

insertResponsibilities

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

Specified by:

insertResponsibilities in interface PlanComponentInterface

removeResponsibilities

public long removeResponsibilities(int index)

Remove the element at the specified index and return it.

Specified by:

removeResponsibilities in interface PlanComponentInterface

removeResponsibilitiesValue

public boolean removeResponsibilitiesValue(long value)

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

Specified by:

removeResponsibilitiesValue in interface PlanComponentInterface

clearResponsibilities

public void clearResponsibilities()

Clears all values from responsibilities

Specified by:

clearResponsibilities in interface PlanComponentInterface

responsibilitiesContains

public boolean responsibilitiesContains(long val)

Returns true if responsibilities contains the specified value.

Specified by:

responsibilitiesContains in interface PlanComponentInterface

responsibilitiesIndexOf

public int responsibilitiesIndexOf(long val)

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

Specified by:

responsibilitiesIndexOf in interface PlanComponentInterface

sizeofResponsibilities

public int sizeofResponsibilities()

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

Specified by:

sizeofResponsibilities in interface PlanComponentInterface

getResponsibilitiesFlag

public static boolean getResponsibilitiesFlag(int fieldflag)

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

getResponsibilitiesDefaultValue

public static long[] getResponsibilitiesDefaultValue()

Default value for responsibilities. Returns new long[0]

getResponsibilitiesElementInvalidValue

public static long getResponsibilitiesElementInvalidValue()

Invalid value for responsibilitieselement. Returns Long.MIN_VALUE

getResponsibilitiesInvalidValue

public static long[] getResponsibilitiesInvalidValue()

Invalid value for responsibilities. Returns null

getResponsibilitiesPrintValue

public java.lang.String getResponsibilitiesPrintValue()

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.

getResponsibilitiesFieldPrintValue

public java.lang.String getResponsibilitiesFieldPrintValue()

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

getResponsibilitiesRange

public java.lang.String getResponsibilitiesRange()

Return the range specification for this field

resolveResponsibilitiesReferencesNoLookup

public Role[] resolveResponsibilitiesReferencesNoLookup()

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

resolveResponsibilitiesReferencesNonCrit

public Role[] resolveResponsibilitiesReferencesNonCrit(org.sandev.basics.util.IDLookup lookup,
                                                       org.sandev.basics.util.AuthUser au)

Resolve the array of reference IDs into an array of instances, without throwing an exception if a given ID cannot be resolved. This supports the UI, which calls this method to get detail on references for display. If the detail is not found, then it's not critical so nulls are allowed in the returned array.

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

resolveResponsibilitiesReferences

public Role[] resolveResponsibilitiesReferences(org.sandev.basics.util.IDLookup lookup,
                                                org.sandev.basics.util.AuthUser au)
                                         throws org.sandev.basics.structs.SandException

Converts this array of references into an array of instances, by looking up each reference ID. If any of the references are invalid or anything else goes wrong, then this method throws. A successful return means all references were resolved.

Throws:

org.sandev.basics.structs.SandException

resolveResponsibilitiesReferences

public Role[] resolveResponsibilitiesReferences(org.sandev.basics.util.IDLookup lookup,
                                                org.sandev.basics.util.AuthUser au,
                                                boolean allowNulls)
                                         throws org.sandev.basics.structs.SandException

Converts this array of references into an array of instances, by looking them up.

Throws:

org.sandev.basics.structs.SandException

resolveResponsibilitiesReferences

public Role[] resolveResponsibilitiesReferences(org.sandev.basics.util.IDLookup lookup,
                                                org.sandev.basics.util.AuthUser au,
                                                org.sandev.basics.structs.SandUpdateMessage[] sums)
                                         throws org.sandev.basics.structs.SandException

Converts this array of references into an array of instances, by looking them up first in the given updates, and then via the IDLookup if not found. This allows for resolving the references against outstanding updates for the most recent data, including new instances with temporary IDs.

Throws:

org.sandev.basics.structs.SandException

getResponsibilitiesValidityCheck

public java.lang.String getResponsibilitiesValidityCheck()

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.

getResponsibilitiesMetatype

public java.lang.String getResponsibilitiesMetatype()

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

getAssignedTo

public long getAssignedTo()

Accessor for assignedTo

Specified by:

getAssignedTo in interface PlanComponentInterface

setAssignedTo

public void setAssignedTo(long assignedTo)

Mutator for assignedTo

Specified by:

setAssignedTo in interface PlanComponentInterface

getAssignedToFlag

public static boolean getAssignedToFlag(int fieldflag)

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

getAssignedToDefaultValue

public static long getAssignedToDefaultValue()

Default value for assignedTo. Returns 0

getAssignedToInvalidValue

public static long getAssignedToInvalidValue()

Invalid value for assignedTo. Returns Long.MIN_VALUE

getAssignedToPrintValue

public java.lang.String getAssignedToPrintValue()

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.

getAssignedToFieldPrintValue

public java.lang.String getAssignedToFieldPrintValue()

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

getAssignedToRange

public java.lang.String getAssignedToRange()

Return the range specification for this field

resolveAssignedToReferenceNonCrit

public HeapAssociation resolveAssignedToReferenceNonCrit(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).

resolveAssignedToReference

public HeapAssociation resolveAssignedToReference(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

getAssignedToValidityCheck

public java.lang.String getAssignedToValidityCheck()

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.

getAssignedToMetatype

public java.lang.String getAssignedToMetatype()

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

getDueType

public int getDueType()

Accessor for dueType

Specified by:

getDueType in interface PlanComponentInterface

setDueType

public void setDueType(int dueType)

Mutator for dueType

Specified by:

setDueType in interface PlanComponentInterface

dueTypeValueToLabel

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

dueTypeValueToLabelStatic

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

dueTypeLabelToValue

public int dueTypeLabelToValue(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.

dueTypeLabelToValueStatic

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

getDueTypePrintVals

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

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.

getDueTypeKeyVals

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

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.

getDueTypeActualVals

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

Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.

dueTypePrint2Key

public static java.lang.String dueTypePrint2Key(java.lang.String printVal)

Utility method to transform a print value for this field into a key value. See the getDueTypePrintVals and getDueTypeKeyVals methods for details.

dueTypePrint2Actual

public static java.lang.String dueTypePrint2Actual(java.lang.String printVal)

Utility method to transform a print value for this field into an actual value. See the getDueTypePrintVals and getDueTypeActualVals methods for details.

dueTypeActual2Print

public static java.lang.String dueTypeActual2Print(java.lang.String actualVal)

Utility method to transform an actual value for this field into a print value. See the getDueTypeActualVals and getDueTypePrintVals methods for details.

getDueTypeEnumSummary

public static java.lang.String getDueTypeEnumSummary()

Return a single String summary of the possible enum values for debug and similar purposes.

getDueTypeFlag

public static boolean getDueTypeFlag(int fieldflag)

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

getDueTypeDefaultValue

public static int getDueTypeDefaultValue()

Default value for dueType. Returns DUETYPE_NONE

getDueTypeInvalidValue

public static int getDueTypeInvalidValue()

Invalid value for dueType. Returns -1

getDueTypePrintValue

public java.lang.String getDueTypePrintValue()

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.

getDueTypeFieldPrintValue

public java.lang.String getDueTypeFieldPrintValue()

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

getDueTypeRange

public java.lang.String getDueTypeRange()

Return the range specification for this field

getDueTypeValidityCheck

public java.lang.String getDueTypeValidityCheck()

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.

getDueTypeMetatype

public java.lang.String getDueTypeMetatype()

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

getDueDate

public java.util.Date getDueDate()

Accessor for dueDate

Specified by:

getDueDate in interface PlanComponentInterface

setDueDate

public void setDueDate(java.util.Date dueDate)

Mutator for dueDate

Specified by:

setDueDate in interface PlanComponentInterface

setDueDate

public void setDueDate(java.lang.Object dueDate)

Generic mutator for dueDate

Specified by:

setDueDate in interface PlanComponentInterface

getDueDateFlag

public static boolean getDueDateFlag(int fieldflag)

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

getDueDateDefaultValue

public static java.util.Date getDueDateDefaultValue()

Default value for dueDate. Returns 1428458375000L

getDueDateInvalidValue

public static java.util.Date getDueDateInvalidValue()

Invalid value for dueDate. Returns null

getDueDatePrintValue

public java.lang.String getDueDatePrintValue()

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.

getDueDateFieldPrintValue

public java.lang.String getDueDateFieldPrintValue()

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

getDueDateRange

public java.lang.String getDueDateRange()

Return the range specification for this field

getDueDateWithOffset

public java.util.Date getDueDateWithOffset()

Return the date value incorporating the timezone offset specified for the field, if any. This method returns the date value of the field from the perspective of the current runtime environment. In other words the local time at the time of the date value for specified time zone.

setDueDateWithOffset

public void setDueDateWithOffset(java.util.Date val)

Set the date value incorporating the timezone offset specified for the field, if any. See corresponding get method for more info.

getDueDateValidityCheck

public java.lang.String getDueDateValidityCheck()

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.

getDueDateMetatype

public java.lang.String getDueDateMetatype()

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

getDueDelta

public int getDueDelta()

Accessor for dueDelta

Specified by:

getDueDelta in interface PlanComponentInterface

setDueDelta

public void setDueDelta(int dueDelta)

Mutator for dueDelta

Specified by:

setDueDelta in interface PlanComponentInterface

getDueDeltaFlag

public static boolean getDueDeltaFlag(int fieldflag)

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

getDueDeltaDefaultValue

public static int getDueDeltaDefaultValue()

Default value for dueDelta. Returns 0

getDueDeltaInvalidValue

public static int getDueDeltaInvalidValue()

Invalid value for dueDelta. Returns Integer.MIN_VALUE

getDueDeltaPrintValue

public java.lang.String getDueDeltaPrintValue()

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.

getDueDeltaFieldPrintValue

public java.lang.String getDueDeltaFieldPrintValue()

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

getDueDeltaRange

public java.lang.String getDueDeltaRange()

Return the range specification for this field

getDueDeltaValidityCheck

public java.lang.String getDueDeltaValidityCheck()

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.

getDueDeltaMetatype

public java.lang.String getDueDeltaMetatype()

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

getDueDeltaValue

public int getDueDeltaValue()

Accessor for dueDeltaValue

Specified by:

getDueDeltaValue in interface PlanComponentInterface

setDueDeltaValue

public void setDueDeltaValue(int dueDeltaValue)

Mutator for dueDeltaValue

Specified by:

setDueDeltaValue in interface PlanComponentInterface

getDueDeltaValueFlag

public static boolean getDueDeltaValueFlag(int fieldflag)

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

getDueDeltaValueDefaultValue

public static int getDueDeltaValueDefaultValue()

Default value for dueDeltaValue. Returns 0

getDueDeltaValueInvalidValue

public static int getDueDeltaValueInvalidValue()

Invalid value for dueDeltaValue. Returns Integer.MIN_VALUE

getDueDeltaValuePrintValue

public java.lang.String getDueDeltaValuePrintValue()

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.

getDueDeltaValueFieldPrintValue

public java.lang.String getDueDeltaValueFieldPrintValue()

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

getDueDeltaValueRange

public java.lang.String getDueDeltaValueRange()

Return the range specification for this field

getDueDeltaValueValidityCheck

public java.lang.String getDueDeltaValueValidityCheck()

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.

getDueDeltaValueMetatype

public java.lang.String getDueDeltaValueMetatype()

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

getDueDeltaSense

public int getDueDeltaSense()

Accessor for dueDeltaSense

Specified by:

getDueDeltaSense in interface PlanComponentInterface

setDueDeltaSense

public void setDueDeltaSense(int dueDeltaSense)

Mutator for dueDeltaSense

Specified by:

setDueDeltaSense in interface PlanComponentInterface

dueDeltaSenseValueToLabel

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

dueDeltaSenseValueToLabelStatic

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

dueDeltaSenseLabelToValue

public int dueDeltaSenseLabelToValue(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.

dueDeltaSenseLabelToValueStatic

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

getDueDeltaSensePrintVals

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

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.

getDueDeltaSenseKeyVals

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

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.

getDueDeltaSenseActualVals

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

Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.

dueDeltaSensePrint2Key

public static java.lang.String dueDeltaSensePrint2Key(java.lang.String printVal)

Utility method to transform a print value for this field into a key value. See the getDueDeltaSensePrintVals and getDueDeltaSenseKeyVals methods for details.

dueDeltaSensePrint2Actual

public static java.lang.String dueDeltaSensePrint2Actual(java.lang.String printVal)

Utility method to transform a print value for this field into an actual value. See the getDueDeltaSensePrintVals and getDueDeltaSenseActualVals methods for details.

dueDeltaSenseActual2Print

public static java.lang.String dueDeltaSenseActual2Print(java.lang.String actualVal)

Utility method to transform an actual value for this field into a print value. See the getDueDeltaSenseActualVals and getDueDeltaSensePrintVals methods for details.

getDueDeltaSenseEnumSummary

public static java.lang.String getDueDeltaSenseEnumSummary()

Return a single String summary of the possible enum values for debug and similar purposes.

getDueDeltaSenseFlag

public static boolean getDueDeltaSenseFlag(int fieldflag)

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

getDueDeltaSenseDefaultValue

public static int getDueDeltaSenseDefaultValue()

Default value for dueDeltaSense. Returns DUEDELTASENSE_BEFORE

getDueDeltaSenseInvalidValue

public static int getDueDeltaSenseInvalidValue()

Invalid value for dueDeltaSense. Returns -1

getDueDeltaSensePrintValue

public java.lang.String getDueDeltaSensePrintValue()

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.

getDueDeltaSenseFieldPrintValue

public java.lang.String getDueDeltaSenseFieldPrintValue()

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

getDueDeltaSenseRange

public java.lang.String getDueDeltaSenseRange()

Return the range specification for this field

getDueDeltaSenseValidityCheck

public java.lang.String getDueDeltaSenseValidityCheck()

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.

getDueDeltaSenseMetatype

public java.lang.String getDueDeltaSenseMetatype()

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

getDueTimeUnits

public int getDueTimeUnits()

Accessor for dueTimeUnits

Specified by:

getDueTimeUnits in interface PlanComponentInterface

setDueTimeUnits

public void setDueTimeUnits(int dueTimeUnits)

Mutator for dueTimeUnits

Specified by:

setDueTimeUnits in interface PlanComponentInterface

dueTimeUnitsValueToLabel

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

dueTimeUnitsValueToLabelStatic

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

dueTimeUnitsLabelToValue

public int dueTimeUnitsLabelToValue(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.

dueTimeUnitsLabelToValueStatic

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

getDueTimeUnitsPrintVals

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

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.

getDueTimeUnitsKeyVals

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

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.

getDueTimeUnitsActualVals

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

Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.

dueTimeUnitsPrint2Key

public static java.lang.String dueTimeUnitsPrint2Key(java.lang.String printVal)

Utility method to transform a print value for this field into a key value. See the getDueTimeUnitsPrintVals and getDueTimeUnitsKeyVals methods for details.

dueTimeUnitsPrint2Actual

public static java.lang.String dueTimeUnitsPrint2Actual(java.lang.String printVal)

Utility method to transform a print value for this field into an actual value. See the getDueTimeUnitsPrintVals and getDueTimeUnitsActualVals methods for details.

dueTimeUnitsActual2Print

public static java.lang.String dueTimeUnitsActual2Print(java.lang.String actualVal)

Utility method to transform an actual value for this field into a print value. See the getDueTimeUnitsActualVals and getDueTimeUnitsPrintVals methods for details.

getDueTimeUnitsEnumSummary

public static java.lang.String getDueTimeUnitsEnumSummary()

Return a single String summary of the possible enum values for debug and similar purposes.

getDueTimeUnitsFlag

public static boolean getDueTimeUnitsFlag(int fieldflag)

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

getDueTimeUnitsDefaultValue

public static int getDueTimeUnitsDefaultValue()

Default value for dueTimeUnits. Returns DUETIMEUNITS_DAYS

getDueTimeUnitsInvalidValue

public static int getDueTimeUnitsInvalidValue()

Invalid value for dueTimeUnits. Returns -1

getDueTimeUnitsPrintValue

public java.lang.String getDueTimeUnitsPrintValue()

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.

getDueTimeUnitsFieldPrintValue

public java.lang.String getDueTimeUnitsFieldPrintValue()

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

getDueTimeUnitsRange

public java.lang.String getDueTimeUnitsRange()

Return the range specification for this field

getDueTimeUnitsValidityCheck

public java.lang.String getDueTimeUnitsValidityCheck()

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.

getDueTimeUnitsMetatype

public java.lang.String getDueTimeUnitsMetatype()

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

getDueReference

public long getDueReference()

Accessor for dueReference

Specified by:

getDueReference in interface PlanComponentInterface

setDueReference

public void setDueReference(long dueReference)

Mutator for dueReference

Specified by:

setDueReference in interface PlanComponentInterface

getDueReferenceFlag

public static boolean getDueReferenceFlag(int fieldflag)

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

getDueReferenceDefaultValue

public static long getDueReferenceDefaultValue()

Default value for dueReference. Returns 0

getDueReferenceInvalidValue

public static long getDueReferenceInvalidValue()

Invalid value for dueReference. Returns Long.MIN_VALUE

getDueReferencePrintValue

public java.lang.String getDueReferencePrintValue()

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.

getDueReferenceFieldPrintValue

public java.lang.String getDueReferenceFieldPrintValue()

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

getDueReferenceRange

public java.lang.String getDueReferenceRange()

Return the range specification for this field

resolveDueReferenceReferenceNonCrit

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

resolveDueReferenceReference

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

getDueReferenceValidityCheck

public java.lang.String getDueReferenceValidityCheck()

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.

getDueReferenceMetatype

public java.lang.String getDueReferenceMetatype()

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

getRelRounding

public int getRelRounding()

Accessor for relRounding

Specified by:

getRelRounding in interface PlanComponentInterface

setRelRounding

public void setRelRounding(int relRounding)

Mutator for relRounding

Specified by:

setRelRounding in interface PlanComponentInterface

relRoundingValueToLabel

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

relRoundingValueToLabelStatic

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

relRoundingLabelToValue

public int relRoundingLabelToValue(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.

relRoundingLabelToValueStatic

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

getRelRoundingPrintVals

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

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.

getRelRoundingKeyVals

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

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.

getRelRoundingActualVals

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

Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.

relRoundingPrint2Key

public static java.lang.String relRoundingPrint2Key(java.lang.String printVal)

Utility method to transform a print value for this field into a key value. See the getRelRoundingPrintVals and getRelRoundingKeyVals methods for details.

relRoundingPrint2Actual

public static java.lang.String relRoundingPrint2Actual(java.lang.String printVal)

Utility method to transform a print value for this field into an actual value. See the getRelRoundingPrintVals and getRelRoundingActualVals methods for details.

relRoundingActual2Print

public static java.lang.String relRoundingActual2Print(java.lang.String actualVal)

Utility method to transform an actual value for this field into a print value. See the getRelRoundingActualVals and getRelRoundingPrintVals methods for details.

getRelRoundingEnumSummary

public static java.lang.String getRelRoundingEnumSummary()

Return a single String summary of the possible enum values for debug and similar purposes.

getRelRoundingFlag

public static boolean getRelRoundingFlag(int fieldflag)

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

getRelRoundingDefaultValue

public static int getRelRoundingDefaultValue()

Default value for relRounding. Returns RELROUNDING_EXACT

getRelRoundingInvalidValue

public static int getRelRoundingInvalidValue()

Invalid value for relRounding. Returns -1

getRelRoundingPrintValue

public java.lang.String getRelRoundingPrintValue()

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.

getRelRoundingFieldPrintValue

public java.lang.String getRelRoundingFieldPrintValue()

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

getRelRoundingRange

public java.lang.String getRelRoundingRange()

Return the range specification for this field

getRelRoundingValidityCheck

public java.lang.String getRelRoundingValidityCheck()

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.

getRelRoundingMetatype

public java.lang.String getRelRoundingMetatype()

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

getRelRoundDay

public int getRelRoundDay()

Accessor for relRoundDay

Specified by:

getRelRoundDay in interface PlanComponentInterface

setRelRoundDay

public void setRelRoundDay(int relRoundDay)

Mutator for relRoundDay

Specified by:

setRelRoundDay in interface PlanComponentInterface

relRoundDayValueToLabel

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

relRoundDayValueToLabelStatic

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

relRoundDayLabelToValue

public int relRoundDayLabelToValue(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.

relRoundDayLabelToValueStatic

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

getRelRoundDayPrintVals

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

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.

getRelRoundDayKeyVals

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

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.

getRelRoundDayActualVals

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

Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.

relRoundDayPrint2Key

public static java.lang.String relRoundDayPrint2Key(java.lang.String printVal)

Utility method to transform a print value for this field into a key value. See the getRelRoundDayPrintVals and getRelRoundDayKeyVals methods for details.

relRoundDayPrint2Actual

public static java.lang.String relRoundDayPrint2Actual(java.lang.String printVal)

Utility method to transform a print value for this field into an actual value. See the getRelRoundDayPrintVals and getRelRoundDayActualVals methods for details.

relRoundDayActual2Print

public static java.lang.String relRoundDayActual2Print(java.lang.String actualVal)

Utility method to transform an actual value for this field into a print value. See the getRelRoundDayActualVals and getRelRoundDayPrintVals methods for details.

getRelRoundDayEnumSummary

public static java.lang.String getRelRoundDayEnumSummary()

Return a single String summary of the possible enum values for debug and similar purposes.

getRelRoundDayFlag

public static boolean getRelRoundDayFlag(int fieldflag)

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

getRelRoundDayDefaultValue

public static int getRelRoundDayDefaultValue()

Default value for relRoundDay. Returns RELROUNDDAY_MONDAY

getRelRoundDayInvalidValue

public static int getRelRoundDayInvalidValue()

Invalid value for relRoundDay. Returns -1

getRelRoundDayPrintValue

public java.lang.String getRelRoundDayPrintValue()

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.

getRelRoundDayFieldPrintValue

public java.lang.String getRelRoundDayFieldPrintValue()

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

getRelRoundDayRange

public java.lang.String getRelRoundDayRange()

Return the range specification for this field

getRelRoundDayValidityCheck

public java.lang.String getRelRoundDayValidityCheck()

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.

getRelRoundDayMetatype

public java.lang.String getRelRoundDayMetatype()

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

getNotes

public Note[] getNotes()

Accessor for notes. The returned value may or may not be the actual data member. Always write back a changed array using setNotes.

Specified by:

getNotes in interface PlanComponentInterface

setNotes

public void setNotes(Note[] notes)

Mutator for notes

Specified by:

setNotes in interface PlanComponentInterface

setNotes

public void setNotes(java.lang.Object[] notes)

Generic mutator for notes

Specified by:

setNotes in interface PlanComponentInterface

addNotes

public void addNotes(Note element)

Appends a value to notes

Specified by:

addNotes in interface PlanComponentInterface

addNotes

public void addNotes(Note[] elements)

Appends an array of values to notes

Specified by:

addNotes in interface PlanComponentInterface

getNotes

public Note getNotes(int index)

Returns the element at the specified index. Returns null if notes is null or smaller than index.

Specified by:

getNotes in interface PlanComponentInterface

setNotes

public void setNotes(int index,
                     Note value)

Set the value at the index specified.

Specified by:

setNotes in interface PlanComponentInterface

insertNotes

public void insertNotes(int index,
                        Note 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.

Specified by:

insertNotes in interface PlanComponentInterface

removeNotes

public Note removeNotes(int index)

Remove the element at the specified index and return it.

Specified by:

removeNotes in interface PlanComponentInterface

removeNotesValue

public boolean removeNotesValue(Note value)

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

Specified by:

removeNotesValue in interface PlanComponentInterface

clearNotes

public void clearNotes()

Clears all values from notes

Specified by:

clearNotes in interface PlanComponentInterface

notesContains

public boolean notesContains(Note val)

Returns true if notes contains the specified value.

Specified by:

notesContains in interface PlanComponentInterface

notesIndexOf

public int notesIndexOf(Note val)

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

Specified by:

notesIndexOf in interface PlanComponentInterface

sizeofNotes

public int sizeofNotes()

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

Specified by:

sizeofNotes in interface PlanComponentInterface

getNotesFlag

public static boolean getNotesFlag(int fieldflag)

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

getNotesLengthNorm

public static int getNotesLengthNorm()

Normal notes length is 512 characters

getNotesLengthMax

public static int getNotesLengthMax()

Maximum notes length is 1048576 characters

getNotesDefaultValue

public static Note[] getNotesDefaultValue()

Default value for notes. Returns new Note[0]

getNotesElementInvalidValue

public static Note getNotesElementInvalidValue()

Invalid value for noteselement. Returns null

getNotesInvalidValue

public static Note[] getNotesInvalidValue()

Invalid value for notes. Returns null

getNotesPrintValue

public java.lang.String getNotesPrintValue()

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.

getNotesFieldPrintValue

public java.lang.String getNotesFieldPrintValue()

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

getNotesRange

public java.lang.String getNotesRange()

Return the range specification for this field

getNotesValidityCheck

public java.lang.String getNotesValidityCheck()

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.

getNotesMetatype

public java.lang.String getNotesMetatype()

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

Specified by:

getUniqueID in interface PlanComponentInterface

setUniqueID

public void setUniqueID(long uniqueID)

Mutator for uniqueID

Specified by:

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

Specified by:

setUniqueID in interface PlanComponentInterface

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

Specified by:

getCreationTime in interface PlanComponentInterface

setCreationTime

public void setCreationTime(java.util.Date creationTime)

Mutator for creationTime

Specified by:

setCreationTime in interface PlanComponentInterface

setCreationTime

public void setCreationTime(java.lang.Object creationTime)

Generic mutator for creationTime

Specified by:

setCreationTime in interface PlanComponentInterface

getCreationTimeFlag

public static boolean getCreationTimeFlag(int fieldflag)

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

getCreationTimeDefaultValue

public static java.util.Date getCreationTimeDefaultValue()

Default value for creationTime. Returns System.currentTimeMillis()

getCreationTimeInvalidValue

public static java.util.Date getCreationTimeInvalidValue()

Invalid value for creationTime. Returns null

getCreationTimePrintValue

public java.lang.String getCreationTimePrintValue()

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

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

getCreationTimeFieldPrintValue

public java.lang.String getCreationTimeFieldPrintValue()

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

getCreationTimeRange

public java.lang.String getCreationTimeRange()

Return the range specification for this field

getCreationTimeWithOffset

public java.util.Date getCreationTimeWithOffset()

Return the date value incorporating the timezone offset specified for the field, if any. This method returns the date value of the field from the perspective of the current runtime environment. In other words the local time at the time of the date value for specified time zone.

setCreationTimeWithOffset

public void setCreationTimeWithOffset(java.util.Date val)

Set the date value incorporating the timezone offset specified for the field, if any. See corresponding get method for more info.

getCreationTimeValidityCheck

public java.lang.String getCreationTimeValidityCheck()

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

getCreationTimeMetatype

public java.lang.String getCreationTimeMetatype()

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

getLastModifiedTime

public java.util.Date getLastModifiedTime()

Accessor for lastModifiedTime

Specified by:

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

Specified by:

getLastModifiedTime in interface PlanComponentInterface

setLastModifiedTime

public void setLastModifiedTime(java.util.Date lastModifiedTime)

Mutator for lastModifiedTime

Specified by:

setLastModifiedTime in interface PlanComponentInterface

setLastModifiedTime

public void setLastModifiedTime(java.lang.Object lastModifiedTime)

Generic mutator for lastModifiedTime

Specified by:

setLastModifiedTime in interface PlanComponentInterface

getLastModifiedTimeFlag

public static boolean getLastModifiedTimeFlag(int fieldflag)

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

getLastModifiedTimeDefaultValue

public static java.util.Date getLastModifiedTimeDefaultValue()

Default value for lastModifiedTime. Returns System.currentTimeMillis()

getLastModifiedTimeInvalidValue

public static java.util.Date getLastModifiedTimeInvalidValue()

Invalid value for lastModifiedTime. Returns null

getLastModifiedTimePrintValue

public java.lang.String getLastModifiedTimePrintValue()

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

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

getLastModifiedTimeFieldPrintValue

public java.lang.String getLastModifiedTimeFieldPrintValue()

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

getLastModifiedTimeRange

public java.lang.String getLastModifiedTimeRange()

Return the range specification for this field

getLastModifiedTimeWithOffset

public java.util.Date getLastModifiedTimeWithOffset()

Return the date value incorporating the timezone offset specified for the field, if any. This method returns the date value of the field from the perspective of the current runtime environment. In other words the local time at the time of the date value for specified time zone.

setLastModifiedTimeWithOffset

public void setLastModifiedTimeWithOffset(java.util.Date val)

Set the date value incorporating the timezone offset specified for the field, if any. See corresponding get method for more info.

getLastModifiedTimeValidityCheck

public java.lang.String getLastModifiedTimeValidityCheck()

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

getLastModifiedTimeMetatype

public java.lang.String getLastModifiedTimeMetatype()

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

getLastModifiedReason

public java.lang.String getLastModifiedReason()

Accessor for lastModifiedReason

Specified by:

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

Specified by:

getLastModifiedReason in interface PlanComponentInterface

setLastModifiedReason

public void setLastModifiedReason(java.lang.String lastModifiedReason)

Mutator for lastModifiedReason

Specified by:

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

Specified by:

setLastModifiedReason in interface PlanComponentInterface

setLastModifiedReason

public void setLastModifiedReason(java.lang.Object lastModifiedReason)

Generic mutator for lastModifiedReason

Specified by:

setLastModifiedReason in interface PlanComponentInterface

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

Specified by:

getRevisionNumber in interface PlanComponentInterface

setRevisionNumber

public void setRevisionNumber(long revisionNumber)

Mutator for revisionNumber

Specified by:

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

Specified by:

setRevisionNumber in interface PlanComponentInterface

getRevisionNumberFlag

public static boolean getRevisionNumberFlag(int fieldflag)

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

getRevisionNumberDefaultValue

public static long getRevisionNumberDefaultValue()

Default value for revisionNumber. Returns 0

getRevisionNumberInvalidValue

public static long getRevisionNumberInvalidValue()

Invalid value for revisionNumber. Returns Long.MIN_VALUE

getRevisionNumberPrintValue

public java.lang.String getRevisionNumberPrintValue()

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

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

getRevisionNumberFieldPrintValue

public java.lang.String getRevisionNumberFieldPrintValue()

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

getRevisionNumberRange

public java.lang.String getRevisionNumberRange()

Return the range specification for this field

getRevisionNumberValidityCheck

public java.lang.String getRevisionNumberValidityCheck()

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

getRevisionNumberMetatype

public java.lang.String getRevisionNumberMetatype()

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

getLastAccessedTime

public java.util.Date getLastAccessedTime()

Accessor for lastAccessedTime

Specified by:

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

Specified by:

getLastAccessedTime in interface PlanComponentInterface

setLastAccessedTime

public void setLastAccessedTime(java.util.Date lastAccessedTime)

Mutator for lastAccessedTime

Specified by:

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

Specified by:

setLastAccessedTime in interface PlanComponentInterface

setLastAccessedTime

public void setLastAccessedTime(java.lang.Object lastAccessedTime)

Generic mutator for lastAccessedTime

Specified by:

setLastAccessedTime in interface PlanComponentInterface

getLastAccessedTimeFlag

public static boolean getLastAccessedTimeFlag(int fieldflag)

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

getLastAccessedTimeDefaultValue

public static java.util.Date getLastAccessedTimeDefaultValue()

Default value for lastAccessedTime. Returns System.currentTimeMillis()

getLastAccessedTimeInvalidValue

public static java.util.Date getLastAccessedTimeInvalidValue()

Invalid value for lastAccessedTime. Returns null

getLastAccessedTimePrintValue

public java.lang.String getLastAccessedTimePrintValue()

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

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

getLastAccessedTimeFieldPrintValue

public java.lang.String getLastAccessedTimeFieldPrintValue()

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

getLastAccessedTimeRange

public java.lang.String getLastAccessedTimeRange()

Return the range specification for this field

getLastAccessedTimeWithOffset

public java.util.Date getLastAccessedTimeWithOffset()

Return the date value incorporating the timezone offset specified for the field, if any. This method returns the date value of the field from the perspective of the current runtime environment. In other words the local time at the time of the date value for specified time zone.

setLastAccessedTimeWithOffset

public void setLastAccessedTimeWithOffset(java.util.Date val)

Set the date value incorporating the timezone offset specified for the field, if any. See corresponding get method for more info.

getLastAccessedTimeValidityCheck

public java.lang.String getLastAccessedTimeValidityCheck()

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

getLastAccessedTimeMetatype

public java.lang.String getLastAccessedTimeMetatype()

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

getInstanceWriteAccess

public int getInstanceWriteAccess()

Accessor for instanceWriteAccess

Specified by:

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

Specified by:

getInstanceWriteAccess in interface PlanComponentInterface

setInstanceWriteAccess

public void setInstanceWriteAccess(int instanceWriteAccess)

Mutator for instanceWriteAccess

Specified by:

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

Specified by:

setInstanceWriteAccess in interface PlanComponentInterface

getInstanceWriteAccessFlag

public static boolean getInstanceWriteAccessFlag(int fieldflag)

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

getInstanceWriteAccessDefaultValue

public static int getInstanceWriteAccessDefaultValue()

Default value for instanceWriteAccess. Returns 0

getInstanceWriteAccessInvalidValue

public static int getInstanceWriteAccessInvalidValue()

Invalid value for instanceWriteAccess. Returns Integer.MIN_VALUE

getInstanceWriteAccessPrintValue

public java.lang.String getInstanceWriteAccessPrintValue()

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

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

getInstanceWriteAccessFieldPrintValue

public java.lang.String getInstanceWriteAccessFieldPrintValue()

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

getInstanceWriteAccessRange

public java.lang.String getInstanceWriteAccessRange()

Return the range specification for this field

getInstanceWriteAccessValidityCheck

public java.lang.String getInstanceWriteAccessValidityCheck()

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

getInstanceWriteAccessMetatype

public java.lang.String getInstanceWriteAccessMetatype()

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

getRecordStatus

public int getRecordStatus()

Accessor for recordStatus

Specified by:

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

Specified by:

getRecordStatus in interface PlanComponentInterface

setRecordStatus

public void setRecordStatus(int recordStatus)

Mutator for recordStatus

Specified by:

setRecordStatus in interface PlanComponentInterface

recordStatusValueToLabel

public java.lang.String recordStatusValueToLabel(int val)

Given a value, return the declared label for it. This is a conversion method suitable for things like XML serialization where the value must be unique, descriptive, and readable, but is not subject to the same degree of transformation as a UI.

recordStatusValueToLabelStatic

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

recordStatusLabelToValue

public int recordStatusLabelToValue(java.lang.String label)

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

recordStatusLabelToValueStatic

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

getRecordStatusPrintVals

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

Return an array of the possible values for this field in display format. These values can be used by a UI directly, or as keys for looking up localized text. These values are not guaranteed to be globally unique, another field with the same possible value may share the same string instance.

getRecordStatusKeyVals

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

Return an array of unique keys for the values of this field. These keys are globally unique and can be used for looking up localized text without any chance of the same key being used by any other field value in the application.

getRecordStatusActualVals

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

Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.

recordStatusPrint2Key

public static java.lang.String recordStatusPrint2Key(java.lang.String printVal)

Utility method to transform a print value for this field into a key value. See the getRecordStatusPrintVals and getRecordStatusKeyVals methods for details.

recordStatusPrint2Actual

public static java.lang.String recordStatusPrint2Actual(java.lang.String printVal)

Utility method to transform a print value for this field into an actual value. See the getRecordStatusPrintVals and getRecordStatusActualVals methods for details.

recordStatusActual2Print

public static java.lang.String recordStatusActual2Print(java.lang.String actualVal)

Utility method to transform an actual value for this field into a print value. See the getRecordStatusActualVals and getRecordStatusPrintVals methods for details.

getRecordStatusEnumSummary

public static java.lang.String getRecordStatusEnumSummary()

Return a single String summary of the possible enum values for debug and similar purposes.

getRecordStatusFlag

public static boolean getRecordStatusFlag(int fieldflag)

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

getRecordStatusDefaultValue

public static int getRecordStatusDefaultValue()

Default value for recordStatus. Returns 0

getRecordStatusInvalidValue

public static int getRecordStatusInvalidValue()

Invalid value for recordStatus. Returns Integer.MIN_VALUE

getRecordStatusPrintValue

public java.lang.String getRecordStatusPrintValue()

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

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

getRecordStatusFieldPrintValue

public java.lang.String getRecordStatusFieldPrintValue()

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

getRecordStatusRange

public java.lang.String getRecordStatusRange()

Return the range specification for this field

getRecordStatusValidityCheck

public java.lang.String getRecordStatusValidityCheck()

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

getRecordStatusMetatype

public java.lang.String getRecordStatusMetatype()

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

init

public void init()

Initialize all fields to their default values

getShortName

public java.lang.String getShortName()

Returns the unqualified name of this message.

Specified by:

getShortName in interface org.sandev.basics.structs.SandMessage

getQueryMessage

public org.sandev.basics.structs.SandQueryMessage getQueryMessage()

Returns a new PlanComponentQuery instance

Specified by:

getQueryMessage in interface org.sandev.basics.structs.SandMessage

getCollectionMessage

public org.sandev.basics.structs.SandCollectionMessage getCollectionMessage()

Returns a new PlanComponentCollection instance

Specified by:

getCollectionMessage in interface org.sandev.basics.structs.SandMessage

getUpdateMessage

public org.sandev.basics.structs.SandUpdateMessage getUpdateMessage()

Returns a new PlanComponentUpdate instance

Specified by:

getUpdateMessage in interface org.sandev.basics.structs.SandMessage

getStructMessage

public org.sandev.basics.structs.SandStructMessage getStructMessage()

Returns a new PlanComponent instance

Specified by:

getStructMessage in interface org.sandev.basics.structs.SandMessage

isEquivalent

public boolean isEquivalent(org.sandev.basics.structs.SandMessage sm)

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

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

Specified by:

isEquivalent in interface org.sandev.basics.structs.SandMessage

getBaseMemoryUse

public int getBaseMemoryUse()

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

Specified by:

getBaseMemoryUse in interface org.sandev.basics.structs.SandMessage

generalModifier

public void generalModifier(int action,
                            java.lang.String field,
                            int index,
                            java.lang.Object val)
                     throws org.sandev.basics.structs.SandException

General mutator method. Specified by SandInstanceMessage interface.

Specified by:

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

Throws:

org.sandev.basics.structs.SandException

generalDereference

public org.sandev.basics.structs.SandAttrVal generalDereference(java.lang.String fieldspec)

General reference field accessor method. Specified by SandInstanceMessage interface.

Specified by:

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

generalAccessor

public java.lang.Object generalAccessor(java.lang.String fieldspec)

General field accessor method. Specified by SandInstanceMessage interface.

Specified by:

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

getDisplayFields

public java.lang.String[] getDisplayFields()

Return an array of the summary field names for this class.

Specified by:

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

getDisplayFieldsPrint

public java.lang.String[] getDisplayFieldsPrint()

Return an array of the summary field print names for this class.

Specified by:

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

getLayoutXML

public java.lang.String getLayoutXML()

Return the fieldlayout XML or null if not defined.

Specified by:

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

getDisplayValues

public java.lang.String[] getDisplayValues()

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

Specified by:

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

getDisplayValues

public java.lang.String[] getDisplayValues(org.sandev.basics.util.IDLookup lookup,
                                           org.sandev.basics.util.AuthUser user,
                                           java.lang.String defaultVal)

Return the values for the summary fields, including dereference expressions.

Specified by:

getDisplayValues in interface org.sandev.basics.util.Resolvable

getValueForFieldName

public java.lang.String getValueForFieldName(java.lang.String fieldname,
                                             org.sandev.basics.util.IDLookup lookup,
                                             org.sandev.basics.util.AuthUser user,
                                             java.lang.String defaultVal)

Returns the print representation of the value of the specified field, or the given default value if innaccessible. A field value may be innaccessible due to authorization, null reference, or other call failure.

Specified by:

getValueForFieldName in interface PlanComponentInterface

getAllFields

public java.lang.String[] getAllFields()

Return an array of all fields for this class.

Specified by:

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

getContainedMessageFields

public java.lang.String[] getContainedMessageFields()

Return an array of all contained message fields.

Specified by:

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

defaultField

public void defaultField(java.lang.String fieldname)

Set the specified field to its default value.

Specified by:

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

getPrintnameForField

public java.lang.String getPrintnameForField(java.lang.String fieldname)

Given a fieldname, return its declared printname if declared. If no printname was declared then this returns the field name.

Specified by:

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

cloneMessage

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

Calls clonePlanComponent

Specified by:

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

clonePlanComponent

public PlanComponent clonePlanComponent()

Make a deep copy of this PlanComponent. Creates a new instance and then calls copyDataFrom.

shallowCopy

public PlanComponent shallowCopy()

Make a shallow copy of this PlanComponent. Creates a new instance and then calls copyDataFrom.

copyDataFrom

public void copyDataFrom(PlanComponent other,
                         boolean deepcopy)

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

copyFieldValue

public void copyFieldValue(java.lang.String fieldName,
                           org.sandev.basics.structs.SandInstanceMessage other)

Copy the specified field from the given instance.

Specified by:

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

fieldValidate

public org.sandev.basics.structs.SandAttrVal[] fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields)

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

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

fieldsValid

public boolean fieldsValid()

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

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

referenceValidate

public java.lang.String[] referenceValidate(java.lang.String[] locations,
                                            java.lang.String prefix,
                                            org.sandev.basics.util.IDLookup idlookup,
                                            org.sandev.basics.util.NameLookup namelookup,
                                            org.sandev.basics.util.AuthUser au)
                                     throws org.sandev.basics.structs.SandException

Validate the references as specified in the Resolvable interface.

Specified by:

referenceValidate in interface org.sandev.basics.util.Resolvable

Throws:

org.sandev.basics.structs.SandException

convertToSuperstructClass

public org.sandev.basics.structs.SandInstanceMessage convertToSuperstructClass()

Return a new instance of the message associated with the superstruct of this instance. Return null if the source struct for this message does not extend another struct.

Specified by:

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

debugDump

public java.lang.String debugDump(java.lang.String prefix)

Dump this instance into a debug printable string.

Specified by:

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

getDisplayID

public java.lang.String getDisplayID()

Return the displayID for this message instance

Specified by:

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

getInstance

public org.sandev.basics.structs.SandPersistMessage getInstance(java.lang.String classname,
                                                                long id)

If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

Specified by:

getInstance in interface org.sandev.basics.structs.SandStructMessage

getInstance

public org.sandev.basics.structs.SandInstanceMessage getInstance(java.lang.String classname,
                                                                 java.lang.String fieldname,
                                                                 java.lang.String value)

If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

Specified by:

getInstance in interface org.sandev.basics.structs.SandStructMessage

find

public org.sandev.basics.structs.SandCollectionMessage find(org.sandev.basics.structs.SandQueryMessage sqm)

Return a matching collection of all directly contained instances matching the given query.

Specified by:

find in interface org.sandev.basics.structs.SandStructMessage

toString

public java.lang.String toString()

Return a string representation of this object. Uses the declared summary fields minus any dereference expressions.

Overrides:

toString in class java.lang.Object