org.sandev.TaskHeap.sandmessages
Class PlanTreeElement

java.lang.Object
  extended byorg.sandev.TaskHeap.structs.PlanTreeElementStruct
      extended byorg.sandev.TaskHeap.sandmessages.PlanTreeElement
All Implemented Interfaces:
org.sandev.basics.util.Resolvable, org.sandev.basics.structs.SandInstanceMessage, org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandStructMessage

public class PlanTreeElement
extends PlanTreeElementStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable

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


Field Summary
static int ASSIGNEDTO_NOBODY
          Possible value for assignedTo
static int ASSIGNEDTO_OTHER
          Possible value for assignedTo
static int ASSIGNEDTO_YOU
          Possible value for assignedTo
static int CURRPLANOFFSET_AFTER
          Possible value for currPlanOffset
static int CURRPLANOFFSET_BEFORE
          Possible value for currPlanOffset
static int PLANSTATUS_CURRPLAN
          Possible value for planStatus
static int PLANSTATUS_NONPLAN
          Possible value for planStatus
static int PLANSTATUS_NOTCURRENT
          Possible value for planStatus
 
Fields inherited from class org.sandev.TaskHeap.structs.PlanTreeElementStruct
activityColor, assignedTo, children, currPlanOffset, dueColor, dueDate, indentUnderscores, lastModifiedTime, lineBackground, lineNumber, name, outlinePath, parent, planComponentID, planStatus, slack, status, targetCompletion, timeEstimate, totalTime
 
Fields inherited from interface org.sandev.basics.structs.SandInstanceMessage
FIELDCHECK_INVALIDVAL, FIELDCHECK_NOTAREF, FIELDCHECK_NOTINRANGE, FIELDCHECK_NULLARRAY, FIELDCHECK_STRINGOVER, FIELDCHECK_UNKNOWNVAL, FIELDFLAG_BINARY, FIELDFLAG_ENCRYPT, FIELDFLAG_INTERNAL, FIELDFLAG_NOECHO, FIELDFLAG_OBFUSCATE, FIELDFLAG_STRINGPERSIST, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET
 
Constructor Summary
PlanTreeElement()
          Default constructor calls init.
 
Method Summary
 void addChildren(PlanTreeElement element)
          Appends a value to children
 void addChildren(PlanTreeElement[] elements)
          Appends an array of values to children
static java.lang.String assignedToActual2Print(java.lang.String actualVal)
          Utility method to transform an actual value for this field into a print value.
 int assignedToLabelToValue(java.lang.String label)
          Given a label, return the value for it.
static java.lang.String assignedToPrint2Actual(java.lang.String printVal)
          Utility method to transform a print value for this field into an actual value.
static java.lang.String assignedToPrint2Key(java.lang.String printVal)
          Utility method to transform a print value for this field into a key value.
 java.lang.String assignedToValueToLabel(int val)
          Given a value, return the declared label for it.
 boolean childrenContains(PlanTreeElement val)
          Returns true if children contains the specified value.
 int childrenIndexOf(PlanTreeElement val)
          Return the index of the specified value in children, or -1 if not found.
 void clearChildren()
          Clears all values from children
 org.sandev.basics.structs.SandInstanceMessage cloneMessage()
          Calls clonePlanTreeElement
 PlanTreeElement clonePlanTreeElement()
          Make a deep copy of this PlanTreeElement.
 org.sandev.basics.structs.SandInstanceMessage convertToSuperstructClass()
          Return a new instance of the message associated with the superstruct of this instance.
 void copyDataFrom(PlanTreeElement other)
          Deep copy all the data from the specified instance.
 void copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.SandInstanceMessage other)
          Copy the specified field from the given instance.
static java.lang.String currPlanOffsetActual2Print(java.lang.String actualVal)
          Utility method to transform an actual value for this field into a print value.
 int currPlanOffsetLabelToValue(java.lang.String label)
          Given a label, return the value for it.
static java.lang.String currPlanOffsetPrint2Actual(java.lang.String printVal)
          Utility method to transform a print value for this field into an actual value.
static java.lang.String currPlanOffsetPrint2Key(java.lang.String printVal)
          Utility method to transform a print value for this field into a key value.
 java.lang.String currPlanOffsetValueToLabel(int val)
          Given a value, return the declared label for it.
 java.lang.String debugDump(java.lang.String prefix)
          Dump this instance into a debug printable string.
 void defaultField(java.lang.String fieldname)
          Set the specified field to its default value.
 boolean fieldHasFlag(java.lang.String fieldname, int fieldflag)
          Return true if the named field declares the indicated flag, false otherwise.
 boolean fieldsValid()
          Validate the fields as specified in the SandInstanceMessage interface
 org.sandev.basics.structs.SandAttrVal[] fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields)
          Validate the fields as specified in the SandInstanceMessage interface
 java.lang.Object generalAccessor(java.lang.String fieldspec)
          General field accessor method.
 org.sandev.basics.structs.SandAttrVal generalDereference(java.lang.String fieldspec)
          General reference field accessor method.
 void generalModifier(int action, java.lang.String field, int index, java.lang.Object val)
          General mutator method.
 java.lang.String getActivityColor()
          Accessor for activityColor
static java.lang.String getActivityColorDefaultValue()
          Default value for activityColor.
 java.lang.String getActivityColorFieldPrintValue()
          Return the print name of the activityColor field.
static boolean getActivityColorFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getActivityColorInvalidValue()
          Invalid value for activityColor.
static int getActivityColorLengthMax()
          Maximum activityColor length is 70 characters
static int getActivityColorLengthNorm()
          Normal activityColor length is 30 characters
 java.lang.String getActivityColorMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getActivityColorPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getActivityColorRange()
          Return the range specification for this field
 java.lang.String getActivityColorValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String[] getAllFields()
          Return an array of all fields for this class.
 int getAssignedTo()
          Accessor for assignedTo
static java.lang.String[] getAssignedToActualVals()
          Return an array of the possible values for this field as Strings.
static int getAssignedToDefaultValue()
          Default value for assignedTo.
static java.lang.String getAssignedToEnumSummary()
          Return a single String summary of the possible enum values for debug and similar purposes.
 java.lang.String getAssignedToFieldPrintValue()
          Return the print name of the assignedTo field.
static boolean getAssignedToFlag(int fieldflag)
          Field flag accessor.
static int getAssignedToInvalidValue()
          Invalid value for assignedTo.
static java.lang.String[] getAssignedToKeyVals()
          Return an array of unique keys for the values of this field.
 java.lang.String getAssignedToMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[] getAssignedToPrintVals()
          Return an array of the possible values for this field in display format.
 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.
 PlanTreeElement[] getChildren()
          Accessor for children
 PlanTreeElement getChildren(int index)
          Returns the element at the specified index.
static PlanTreeElement[] getChildrenDefaultValue()
          Default value for children.
static PlanTreeElement getChildrenElementInvalidValue()
          Invalid value for childrenelement.
static boolean getChildrenFlag(int fieldflag)
          Field flag accessor.
static PlanTreeElement[] getChildrenInvalidValue()
          Invalid value for children.
 java.lang.String getChildrenMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getChildrenRange()
          Return the range specification for this field
 java.lang.String getChildrenValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 org.sandev.basics.structs.SandCollectionMessage getCollectionMessage()
          Returns null
 int getCurrPlanOffset()
          Accessor for currPlanOffset
static java.lang.String[] getCurrPlanOffsetActualVals()
          Return an array of the possible values for this field as Strings.
static int getCurrPlanOffsetDefaultValue()
          Default value for currPlanOffset.
static java.lang.String getCurrPlanOffsetEnumSummary()
          Return a single String summary of the possible enum values for debug and similar purposes.
 java.lang.String getCurrPlanOffsetFieldPrintValue()
          Return the print name of the currPlanOffset field.
static boolean getCurrPlanOffsetFlag(int fieldflag)
          Field flag accessor.
static int getCurrPlanOffsetInvalidValue()
          Invalid value for currPlanOffset.
static java.lang.String[] getCurrPlanOffsetKeyVals()
          Return an array of unique keys for the values of this field.
 java.lang.String getCurrPlanOffsetMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[] getCurrPlanOffsetPrintVals()
          Return an array of the possible values for this field in display format.
 java.lang.String getCurrPlanOffsetPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getCurrPlanOffsetRange()
          Return the range specification for this field
 java.lang.String getCurrPlanOffsetValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String[] getDisplayFields()
          Return an array of the summary field names for this class.
 java.lang.String[] getDisplayValues()
          Return the values for the summary fields.
 java.lang.String[] getDisplayValues(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal)
          Return the values for the summary fields, including dereference expressions.
 java.lang.String getDueColor()
          Accessor for dueColor
static java.lang.String getDueColorDefaultValue()
          Default value for dueColor.
 java.lang.String getDueColorFieldPrintValue()
          Return the print name of the dueColor field.
static boolean getDueColorFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getDueColorInvalidValue()
          Invalid value for dueColor.
static int getDueColorLengthMax()
          Maximum dueColor length is 70 characters
static int getDueColorLengthNorm()
          Normal dueColor length is 30 characters
 java.lang.String getDueColorMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getDueColorPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getDueColorRange()
          Return the range specification for this field
 java.lang.String getDueColorValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getDueDate()
          Accessor for dueDate
static java.lang.String 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.lang.String getDueDateInvalidValue()
          Invalid value for dueDate.
static int getDueDateLengthMax()
          Maximum dueDate length is 70 characters
static int getDueDateLengthNorm()
          Normal dueDate length is 30 characters
 java.lang.String getDueDateMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getDueDatePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getDueDateRange()
          Return the range specification for this field
 java.lang.String getDueDateValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getIndentUnderscores()
          Accessor for indentUnderscores
static java.lang.String getIndentUnderscoresDefaultValue()
          Default value for indentUnderscores.
 java.lang.String getIndentUnderscoresFieldPrintValue()
          Return the print name of the indentUnderscores field.
static boolean getIndentUnderscoresFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getIndentUnderscoresInvalidValue()
          Invalid value for indentUnderscores.
static int getIndentUnderscoresLengthMax()
          Maximum indentUnderscores length is 70 characters
static int getIndentUnderscoresLengthNorm()
          Normal indentUnderscores length is 30 characters
 java.lang.String getIndentUnderscoresMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getIndentUnderscoresPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getIndentUnderscoresRange()
          Return the range specification for this field
 java.lang.String getIndentUnderscoresValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.util.Date getLastModifiedTime()
          Accessor for lastModifiedTime
static java.util.Date getLastModifiedTimeDefaultValue()
          Default value for lastModifiedTime.
 java.lang.String getLastModifiedTimeFieldPrintValue()
          Return the print name of the lastModifiedTime field.
static boolean getLastModifiedTimeFlag(int fieldflag)
          Field flag accessor.
static java.util.Date getLastModifiedTimeInvalidValue()
          Invalid value for lastModifiedTime.
 java.lang.String getLastModifiedTimeMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getLastModifiedTimePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getLastModifiedTimeRange()
          Return the range specification for this field
 java.lang.String getLastModifiedTimeValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getLineBackground()
          Accessor for lineBackground
static java.lang.String getLineBackgroundDefaultValue()
          Default value for lineBackground.
 java.lang.String getLineBackgroundFieldPrintValue()
          Return the print name of the lineBackground field.
static boolean getLineBackgroundFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getLineBackgroundInvalidValue()
          Invalid value for lineBackground.
static int getLineBackgroundLengthMax()
          Maximum lineBackground length is 70 characters
static int getLineBackgroundLengthNorm()
          Normal lineBackground length is 30 characters
 java.lang.String getLineBackgroundMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getLineBackgroundPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getLineBackgroundRange()
          Return the range specification for this field
 java.lang.String getLineBackgroundValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 int getLineNumber()
          Accessor for lineNumber
static int getLineNumberDefaultValue()
          Default value for lineNumber.
 java.lang.String getLineNumberFieldPrintValue()
          Return the print name of the lineNumber field.
static boolean getLineNumberFlag(int fieldflag)
          Field flag accessor.
static int getLineNumberInvalidValue()
          Invalid value for lineNumber.
 java.lang.String getLineNumberMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getLineNumberPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getLineNumberRange()
          Return the range specification for this field
 java.lang.String getLineNumberValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getName()
          Accessor for name
static java.lang.String getNameDefaultValue()
          Default value for name.
 java.lang.String getNameFieldPrintValue()
          Return the print name of the name field.
static boolean getNameFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getNameInvalidValue()
          Invalid value for name.
static int getNameLengthMax()
          Maximum name length is 80 characters
static int getNameLengthNorm()
          Normal name length is 30 characters
 java.lang.String getNameMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getNamePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getNameRange()
          Return the range specification for this field
 java.lang.String getNameValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getOutlinePath()
          Accessor for outlinePath
static java.lang.String getOutlinePathDefaultValue()
          Default value for outlinePath.
 java.lang.String getOutlinePathFieldPrintValue()
          Return the print name of the outlinePath field.
static boolean getOutlinePathFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getOutlinePathInvalidValue()
          Invalid value for outlinePath.
static int getOutlinePathLengthMax()
          Maximum outlinePath length is 80 characters
static int getOutlinePathLengthNorm()
          Normal outlinePath length is 30 characters
 java.lang.String getOutlinePathMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getOutlinePathPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getOutlinePathRange()
          Return the range specification for this field
 java.lang.String getOutlinePathValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 PlanTreeElement getParent()
          Accessor for parent
static PlanTreeElement 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 PlanTreeElement 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.
 long getPlanComponentID()
          Accessor for planComponentID
static long getPlanComponentIDDefaultValue()
          Default value for planComponentID.
 java.lang.String getPlanComponentIDFieldPrintValue()
          Return the print name of the planComponentID field.
static boolean getPlanComponentIDFlag(int fieldflag)
          Field flag accessor.
static long getPlanComponentIDInvalidValue()
          Invalid value for planComponentID.
 java.lang.String getPlanComponentIDMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getPlanComponentIDPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getPlanComponentIDRange()
          Return the range specification for this field
 java.lang.String getPlanComponentIDValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 int getPlanStatus()
          Accessor for planStatus
static java.lang.String[] getPlanStatusActualVals()
          Return an array of the possible values for this field as Strings.
static int getPlanStatusDefaultValue()
          Default value for planStatus.
static java.lang.String getPlanStatusEnumSummary()
          Return a single String summary of the possible enum values for debug and similar purposes.
 java.lang.String getPlanStatusFieldPrintValue()
          Return the print name of the planStatus field.
static boolean getPlanStatusFlag(int fieldflag)
          Field flag accessor.
static int getPlanStatusInvalidValue()
          Invalid value for planStatus.
static java.lang.String[] getPlanStatusKeyVals()
          Return an array of unique keys for the values of this field.
 java.lang.String getPlanStatusMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[] getPlanStatusPrintVals()
          Return an array of the possible values for this field in display format.
 java.lang.String getPlanStatusPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getPlanStatusRange()
          Return the range specification for this field
 java.lang.String getPlanStatusValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 org.sandev.basics.structs.SandQueryMessage getQueryMessage()
          Returns null
 java.lang.String getShortName()
          Returns the unqualified name of this message.
 long getSlack()
          Accessor for slack
static long getSlackDefaultValue()
          Default value for slack.
 java.lang.String getSlackFieldPrintValue()
          Return the print name of the slack field.
static boolean getSlackFlag(int fieldflag)
          Field flag accessor.
static long getSlackInvalidValue()
          Invalid value for slack.
 java.lang.String getSlackMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getSlackPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getSlackRange()
          Return the range specification for this field
 java.lang.String getSlackValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getStatus()
          Accessor for status
static java.lang.String getStatusDefaultValue()
          Default value for status.
 java.lang.String getStatusFieldPrintValue()
          Return the print name of the status field.
static boolean getStatusFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getStatusInvalidValue()
          Invalid value for status.
static int getStatusLengthMax()
          Maximum status length is 70 characters
static int getStatusLengthNorm()
          Normal status length is 30 characters
 java.lang.String getStatusMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getStatusPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getStatusRange()
          Return the range specification for this field
 java.lang.String getStatusValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 org.sandev.basics.structs.SandStructMessage getStructMessage()
          Returns a new PlanTreeElement instance
 java.lang.String getTargetCompletion()
          Accessor for targetCompletion
static java.lang.String getTargetCompletionDefaultValue()
          Default value for targetCompletion.
 java.lang.String getTargetCompletionFieldPrintValue()
          Return the print name of the targetCompletion field.
static boolean getTargetCompletionFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getTargetCompletionInvalidValue()
          Invalid value for targetCompletion.
static int getTargetCompletionLengthMax()
          Maximum targetCompletion length is 70 characters
static int getTargetCompletionLengthNorm()
          Normal targetCompletion length is 30 characters
 java.lang.String getTargetCompletionMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getTargetCompletionPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getTargetCompletionRange()
          Return the range specification for this field
 java.lang.String getTargetCompletionValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 long getTimeEstimate()
          Accessor for timeEstimate
static long getTimeEstimateDefaultValue()
          Default value for timeEstimate.
 java.lang.String getTimeEstimateFieldPrintValue()
          Return the print name of the timeEstimate field.
static boolean getTimeEstimateFlag(int fieldflag)
          Field flag accessor.
static long getTimeEstimateInvalidValue()
          Invalid value for timeEstimate.
 java.lang.String getTimeEstimateMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getTimeEstimatePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getTimeEstimateRange()
          Return the range specification for this field
 java.lang.String getTimeEstimateValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 long getTotalTime()
          Accessor for totalTime
static long getTotalTimeDefaultValue()
          Default value for totalTime.
 java.lang.String getTotalTimeFieldPrintValue()
          Return the print name of the totalTime field.
static boolean getTotalTimeFlag(int fieldflag)
          Field flag accessor.
static long getTotalTimeInvalidValue()
          Invalid value for totalTime.
 java.lang.String getTotalTimeMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getTotalTimePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getTotalTimeRange()
          Return the range specification for this field
 java.lang.String getTotalTimeValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 PlanTreeElement[] getTreeChildren()
          Tree accessor for child references
 PlanTreeElement getTreeParent()
          Tree accessor for parent reference
 org.sandev.basics.structs.SandUpdateMessage getUpdateMessage()
          Returns null
 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 insertChildren(int index, PlanTreeElement value)
          Insert the specified element at the specified index.
 boolean isEquivalent(org.sandev.basics.structs.SandMessage sm)
          Declared field equivalence check as specified by the SandMessage interface.
static java.lang.String planStatusActual2Print(java.lang.String actualVal)
          Utility method to transform an actual value for this field into a print value.
 int planStatusLabelToValue(java.lang.String label)
          Given a label, return the value for it.
static java.lang.String planStatusPrint2Actual(java.lang.String printVal)
          Utility method to transform a print value for this field into an actual value.
static java.lang.String planStatusPrint2Key(java.lang.String printVal)
          Utility method to transform a print value for this field into a key value.
 java.lang.String planStatusValueToLabel(int val)
          Given a value, return the declared label for it.
 java.lang.String[] referenceValidate(java.lang.String[] locations, java.lang.String prefix, org.sandev.basics.util.IDLookup idlookup, org.sandev.basics.util.NameLookup namelookup, org.sandev.basics.util.AuthUser au)
          Validate the references as specified in the Resolvable interface.
 PlanTreeElement removeChildren(int index)
          Remove the element at the specified index and return it.
 boolean removeChildrenValue(PlanTreeElement value)
          Removes the given element from children.
 PlanComponent resolvePlanComponentIDReference(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au)
          Converts a reference to an instance by looking it up.
 PlanComponent resolvePlanComponentIDReferenceNonCrit(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au)
          Calls standard method, eating any SandException and returning a new instance uniqueID -1.
 void setActivityColor(java.lang.Object activityColor)
          Generic mutator for activityColor
 void setActivityColor(java.lang.String activityColor)
          Mutator for activityColor
 void setAssignedTo(int assignedTo)
          Mutator for assignedTo
 void setChildren(int index, PlanTreeElement value)
          Set the value at the index specified.
 void setChildren(java.lang.Object[] children)
          Generic mutator for children
 void setChildren(PlanTreeElement[] children)
          Mutator for children
 void setCurrPlanOffset(int currPlanOffset)
          Mutator for currPlanOffset
 void setDueColor(java.lang.Object dueColor)
          Generic mutator for dueColor
 void setDueColor(java.lang.String dueColor)
          Mutator for dueColor
 void setDueDate(java.lang.Object dueDate)
          Generic mutator for dueDate
 void setDueDate(java.lang.String dueDate)
          Mutator for dueDate
 void setIndentUnderscores(java.lang.Object indentUnderscores)
          Generic mutator for indentUnderscores
 void setIndentUnderscores(java.lang.String indentUnderscores)
          Mutator for indentUnderscores
 void setLastModifiedTime(java.util.Date lastModifiedTime)
          Mutator for lastModifiedTime
 void setLastModifiedTime(java.lang.Object lastModifiedTime)
          Generic mutator for lastModifiedTime
 void setLineBackground(java.lang.Object lineBackground)
          Generic mutator for lineBackground
 void setLineBackground(java.lang.String lineBackground)
          Mutator for lineBackground
 void setLineNumber(int lineNumber)
          Mutator for lineNumber
 void setName(java.lang.Object name)
          Generic mutator for name
 void setName(java.lang.String name)
          Mutator for name
 void setOutlinePath(java.lang.Object outlinePath)
          Generic mutator for outlinePath
 void setOutlinePath(java.lang.String outlinePath)
          Mutator for outlinePath
 void setParent(java.lang.Object parent)
          Generic mutator for parent
 void setParent(PlanTreeElement parent)
          Mutator for parent
 void setPlanComponentID(long planComponentID)
          Mutator for planComponentID
 void setPlanStatus(int planStatus)
          Mutator for planStatus
 void setSlack(long slack)
          Mutator for slack
 void setStatus(java.lang.Object status)
          Generic mutator for status
 void setStatus(java.lang.String status)
          Mutator for status
 void setTargetCompletion(java.lang.Object targetCompletion)
          Generic mutator for targetCompletion
 void setTargetCompletion(java.lang.String targetCompletion)
          Mutator for targetCompletion
 void setTimeEstimate(long timeEstimate)
          Mutator for timeEstimate
 void setTotalTime(long totalTime)
          Mutator for totalTime
 int sizeofChildren()
          Returns the size of children.
 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

PLANSTATUS_NONPLAN

public static final int PLANSTATUS_NONPLAN
Possible value for planStatus

See Also:
Constant Field Values

PLANSTATUS_NOTCURRENT

public static final int PLANSTATUS_NOTCURRENT
Possible value for planStatus

See Also:
Constant Field Values

PLANSTATUS_CURRPLAN

public static final int PLANSTATUS_CURRPLAN
Possible value for planStatus

See Also:
Constant Field Values

CURRPLANOFFSET_BEFORE

public static final int CURRPLANOFFSET_BEFORE
Possible value for currPlanOffset

See Also:
Constant Field Values

CURRPLANOFFSET_AFTER

public static final int CURRPLANOFFSET_AFTER
Possible value for currPlanOffset

See Also:
Constant Field Values

ASSIGNEDTO_NOBODY

public static final int ASSIGNEDTO_NOBODY
Possible value for assignedTo

See Also:
Constant Field Values

ASSIGNEDTO_YOU

public static final int ASSIGNEDTO_YOU
Possible value for assignedTo

See Also:
Constant Field Values

ASSIGNEDTO_OTHER

public static final int ASSIGNEDTO_OTHER
Possible value for assignedTo

See Also:
Constant Field Values
Constructor Detail

PlanTreeElement

public PlanTreeElement()
Default constructor calls init.

Method Detail

fieldHasFlag

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

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

getPlanComponentID

public long getPlanComponentID()
Accessor for planComponentID


setPlanComponentID

public void setPlanComponentID(long planComponentID)
Mutator for planComponentID


getPlanComponentIDFlag

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


getPlanComponentIDDefaultValue

public static long getPlanComponentIDDefaultValue()
Default value for planComponentID. Returns 0


getPlanComponentIDInvalidValue

public static long getPlanComponentIDInvalidValue()
Invalid value for planComponentID. Returns Long.MIN_VALUE


getPlanComponentIDPrintValue

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


getPlanComponentIDFieldPrintValue

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


getPlanComponentIDRange

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


resolvePlanComponentIDReferenceNonCrit

public PlanComponent resolvePlanComponentIDReferenceNonCrit(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).


resolvePlanComponentIDReference

public PlanComponent resolvePlanComponentIDReference(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

getPlanComponentIDValidityCheck

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


getPlanComponentIDMetatype

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


getName

public java.lang.String getName()
Accessor for name


setName

public void setName(java.lang.String name)
Mutator for name


setName

public void setName(java.lang.Object name)
Generic mutator for name


getNameFlag

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


getNameLengthNorm

public static int getNameLengthNorm()
Normal name length is 30 characters


getNameLengthMax

public static int getNameLengthMax()
Maximum name length is 80 characters


getNameDefaultValue

public static java.lang.String getNameDefaultValue()
Default value for name. Returns ""


getNameInvalidValue

public static java.lang.String getNameInvalidValue()
Invalid value for name. Returns "TASKHEAP_INVALID_NAME"


getNamePrintValue

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

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


getNameFieldPrintValue

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


getNameRange

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


getNameValidityCheck

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


getNameMetatype

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


getOutlinePath

public java.lang.String getOutlinePath()
Accessor for outlinePath


setOutlinePath

public void setOutlinePath(java.lang.String outlinePath)
Mutator for outlinePath


setOutlinePath

public void setOutlinePath(java.lang.Object outlinePath)
Generic mutator for outlinePath


getOutlinePathFlag

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


getOutlinePathLengthNorm

public static int getOutlinePathLengthNorm()
Normal outlinePath length is 30 characters


getOutlinePathLengthMax

public static int getOutlinePathLengthMax()
Maximum outlinePath length is 80 characters


getOutlinePathDefaultValue

public static java.lang.String getOutlinePathDefaultValue()
Default value for outlinePath. Returns ""


getOutlinePathInvalidValue

public static java.lang.String getOutlinePathInvalidValue()
Invalid value for outlinePath. Returns "TASKHEAP_INVALID_OUTLINEPATH"


getOutlinePathPrintValue

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


getOutlinePathFieldPrintValue

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


getOutlinePathRange

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


getOutlinePathValidityCheck

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


getOutlinePathMetatype

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


getTimeEstimate

public long getTimeEstimate()
Accessor for timeEstimate


setTimeEstimate

public void setTimeEstimate(long timeEstimate)
Mutator for timeEstimate


getTimeEstimateFlag

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


getTimeEstimateDefaultValue

public static long getTimeEstimateDefaultValue()
Default value for timeEstimate. Returns 0


getTimeEstimateInvalidValue

public static long getTimeEstimateInvalidValue()
Invalid value for timeEstimate. Returns Long.MIN_VALUE


getTimeEstimatePrintValue

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

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


getTimeEstimateFieldPrintValue

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


getTimeEstimateRange

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


getTimeEstimateValidityCheck

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


getTimeEstimateMetatype

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


getTotalTime

public long getTotalTime()
Accessor for totalTime


setTotalTime

public void setTotalTime(long totalTime)
Mutator for totalTime


getTotalTimeFlag

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


getTotalTimeDefaultValue

public static long getTotalTimeDefaultValue()
Default value for totalTime. Returns 0


getTotalTimeInvalidValue

public static long getTotalTimeInvalidValue()
Invalid value for totalTime. Returns Long.MIN_VALUE


getTotalTimePrintValue

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


getTotalTimeFieldPrintValue

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


getTotalTimeRange

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


getTotalTimeValidityCheck

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


getTotalTimeMetatype

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


getTargetCompletion

public java.lang.String getTargetCompletion()
Accessor for targetCompletion


setTargetCompletion

public void setTargetCompletion(java.lang.String targetCompletion)
Mutator for targetCompletion


setTargetCompletion

public void setTargetCompletion(java.lang.Object targetCompletion)
Generic mutator for targetCompletion


getTargetCompletionFlag

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


getTargetCompletionLengthNorm

public static int getTargetCompletionLengthNorm()
Normal targetCompletion length is 30 characters


getTargetCompletionLengthMax

public static int getTargetCompletionLengthMax()
Maximum targetCompletion length is 70 characters


getTargetCompletionDefaultValue

public static java.lang.String getTargetCompletionDefaultValue()
Default value for targetCompletion. Returns ""


getTargetCompletionInvalidValue

public static java.lang.String getTargetCompletionInvalidValue()
Invalid value for targetCompletion. Returns null


getTargetCompletionPrintValue

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


getTargetCompletionFieldPrintValue

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


getTargetCompletionRange

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


getTargetCompletionValidityCheck

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


getTargetCompletionMetatype

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


getSlack

public long getSlack()
Accessor for slack


setSlack

public void setSlack(long slack)
Mutator for slack


getSlackFlag

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


getSlackDefaultValue

public static long getSlackDefaultValue()
Default value for slack. Returns 0


getSlackInvalidValue

public static long getSlackInvalidValue()
Invalid value for slack. Returns Long.MIN_VALUE


getSlackPrintValue

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


getSlackFieldPrintValue

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


getSlackRange

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


getSlackValidityCheck

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


getSlackMetatype

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


getStatus

public java.lang.String getStatus()
Accessor for status


setStatus

public void setStatus(java.lang.String status)
Mutator for status


setStatus

public void setStatus(java.lang.Object status)
Generic mutator for status


getStatusFlag

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


getStatusLengthNorm

public static int getStatusLengthNorm()
Normal status length is 30 characters


getStatusLengthMax

public static int getStatusLengthMax()
Maximum status length is 70 characters


getStatusDefaultValue

public static java.lang.String getStatusDefaultValue()
Default value for status. Returns ""


getStatusInvalidValue

public static java.lang.String getStatusInvalidValue()
Invalid value for status. Returns null


getStatusPrintValue

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


getStatusFieldPrintValue

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


getStatusRange

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


getStatusValidityCheck

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


getStatusMetatype

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


getActivityColor

public java.lang.String getActivityColor()
Accessor for activityColor


setActivityColor

public void setActivityColor(java.lang.String activityColor)
Mutator for activityColor


setActivityColor

public void setActivityColor(java.lang.Object activityColor)
Generic mutator for activityColor


getActivityColorFlag

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


getActivityColorLengthNorm

public static int getActivityColorLengthNorm()
Normal activityColor length is 30 characters


getActivityColorLengthMax

public static int getActivityColorLengthMax()
Maximum activityColor length is 70 characters


getActivityColorDefaultValue

public static java.lang.String getActivityColorDefaultValue()
Default value for activityColor. Returns ""


getActivityColorInvalidValue

public static java.lang.String getActivityColorInvalidValue()
Invalid value for activityColor. Returns null


getActivityColorPrintValue

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


getActivityColorFieldPrintValue

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


getActivityColorRange

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


getActivityColorValidityCheck

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


getActivityColorMetatype

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


getParent

public PlanTreeElement getParent()
Accessor for parent


setParent

public void setParent(PlanTreeElement parent)
Mutator for parent


setParent

public void setParent(java.lang.Object parent)
Generic mutator for parent


getParentFlag

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


getTreeParent

public PlanTreeElement getTreeParent()
Tree accessor for parent reference


getParentDefaultValue

public static PlanTreeElement getParentDefaultValue()
Default value for parent. Returns null


getParentInvalidValue

public static PlanTreeElement getParentInvalidValue()
Invalid value for parent. Returns null


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


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.


getChildren

public PlanTreeElement[] getChildren()
Accessor for children


setChildren

public void setChildren(PlanTreeElement[] children)
Mutator for children


setChildren

public void setChildren(java.lang.Object[] children)
Generic mutator for children


addChildren

public void addChildren(PlanTreeElement element)
Appends a value to children


addChildren

public void addChildren(PlanTreeElement[] elements)
Appends an array of values to children


getChildren

public PlanTreeElement getChildren(int index)
Returns the element at the specified index. Returns null/-1 if the index was out of bounds.


setChildren

public void setChildren(int index,
                        PlanTreeElement value)
Set the value at the index specified.


insertChildren

public void insertChildren(int index,
                           PlanTreeElement 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.


removeChildren

public PlanTreeElement removeChildren(int index)
Remove the element at the specified index and return it.


removeChildrenValue

public boolean removeChildrenValue(PlanTreeElement value)
Removes the given element from children. Returns true if the element was found.


clearChildren

public void clearChildren()
Clears all values from children


childrenContains

public boolean childrenContains(PlanTreeElement val)
Returns true if children contains the specified value.


childrenIndexOf

public int childrenIndexOf(PlanTreeElement val)
Return the index of the specified value in children, or -1 if not found.


sizeofChildren

public int sizeofChildren()
Returns the size of children. Returns -1 if children is null.


getChildrenFlag

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


getTreeChildren

public PlanTreeElement[] getTreeChildren()
Tree accessor for child references


getChildrenDefaultValue

public static PlanTreeElement[] getChildrenDefaultValue()
Default value for children. Returns new PlanTreeElement[0]


getChildrenElementInvalidValue

public static PlanTreeElement getChildrenElementInvalidValue()
Invalid value for childrenelement. Returns null


getChildrenInvalidValue

public static PlanTreeElement[] getChildrenInvalidValue()
Invalid value for children. Returns null


getChildrenRange

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


getChildrenValidityCheck

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


getChildrenMetatype

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


getLastModifiedTime

public java.util.Date getLastModifiedTime()
Accessor for lastModifiedTime


setLastModifiedTime

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


setLastModifiedTime

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


getLastModifiedTimeFlag

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


getLastModifiedTimeDefaultValue

public static java.util.Date getLastModifiedTimeDefaultValue()
Default value for lastModifiedTime. Returns System.currentTimeMillis()


getLastModifiedTimeInvalidValue

public static java.util.Date getLastModifiedTimeInvalidValue()
Invalid value for lastModifiedTime. Returns null


getLastModifiedTimePrintValue

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

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


getLastModifiedTimeFieldPrintValue

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


getLastModifiedTimeRange

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


getLastModifiedTimeValidityCheck

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


getLastModifiedTimeMetatype

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


getIndentUnderscores

public java.lang.String getIndentUnderscores()
Accessor for indentUnderscores


setIndentUnderscores

public void setIndentUnderscores(java.lang.String indentUnderscores)
Mutator for indentUnderscores


setIndentUnderscores

public void setIndentUnderscores(java.lang.Object indentUnderscores)
Generic mutator for indentUnderscores


getIndentUnderscoresFlag

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


getIndentUnderscoresLengthNorm

public static int getIndentUnderscoresLengthNorm()
Normal indentUnderscores length is 30 characters


getIndentUnderscoresLengthMax

public static int getIndentUnderscoresLengthMax()
Maximum indentUnderscores length is 70 characters


getIndentUnderscoresDefaultValue

public static java.lang.String getIndentUnderscoresDefaultValue()
Default value for indentUnderscores. Returns ""


getIndentUnderscoresInvalidValue

public static java.lang.String getIndentUnderscoresInvalidValue()
Invalid value for indentUnderscores. Returns null


getIndentUnderscoresPrintValue

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


getIndentUnderscoresFieldPrintValue

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


getIndentUnderscoresRange

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


getIndentUnderscoresValidityCheck

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


getIndentUnderscoresMetatype

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


getLineNumber

public int getLineNumber()
Accessor for lineNumber


setLineNumber

public void setLineNumber(int lineNumber)
Mutator for lineNumber


getLineNumberFlag

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


getLineNumberDefaultValue

public static int getLineNumberDefaultValue()
Default value for lineNumber. Returns 0


getLineNumberInvalidValue

public static int getLineNumberInvalidValue()
Invalid value for lineNumber. Returns Integer.MIN_VALUE


getLineNumberPrintValue

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


getLineNumberFieldPrintValue

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


getLineNumberRange

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


getLineNumberValidityCheck

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


getLineNumberMetatype

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


getLineBackground

public java.lang.String getLineBackground()
Accessor for lineBackground


setLineBackground

public void setLineBackground(java.lang.String lineBackground)
Mutator for lineBackground


setLineBackground

public void setLineBackground(java.lang.Object lineBackground)
Generic mutator for lineBackground


getLineBackgroundFlag

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


getLineBackgroundLengthNorm

public static int getLineBackgroundLengthNorm()
Normal lineBackground length is 30 characters


getLineBackgroundLengthMax

public static int getLineBackgroundLengthMax()
Maximum lineBackground length is 70 characters


getLineBackgroundDefaultValue

public static java.lang.String getLineBackgroundDefaultValue()
Default value for lineBackground. Returns ""


getLineBackgroundInvalidValue

public static java.lang.String getLineBackgroundInvalidValue()
Invalid value for lineBackground. Returns null


getLineBackgroundPrintValue

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


getLineBackgroundFieldPrintValue

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


getLineBackgroundRange

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


getLineBackgroundValidityCheck

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


getLineBackgroundMetatype

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


getPlanStatus

public int getPlanStatus()
Accessor for planStatus


setPlanStatus

public void setPlanStatus(int planStatus)
Mutator for planStatus


planStatusValueToLabel

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


planStatusLabelToValue

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


getPlanStatusPrintVals

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


getPlanStatusKeyVals

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


getPlanStatusActualVals

public static java.lang.String[] getPlanStatusActualVals()
Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.


planStatusPrint2Key

public static java.lang.String planStatusPrint2Key(java.lang.String printVal)
Utility method to transform a print value for this field into a key value. See the getPlanStatusPrintVals and getPlanStatusKeyVals methods for details.


planStatusPrint2Actual

public static java.lang.String planStatusPrint2Actual(java.lang.String printVal)
Utility method to transform a print value for this field into an actual value. See the getPlanStatusPrintVals and getPlanStatusActualVals methods for details.


planStatusActual2Print

public static java.lang.String planStatusActual2Print(java.lang.String actualVal)
Utility method to transform an actual value for this field into a print value. See the getPlanStatusActualVals and getPlanStatusPrintVals methods for details.


getPlanStatusEnumSummary

public static java.lang.String getPlanStatusEnumSummary()
Return a single String summary of the possible enum values for debug and similar purposes.


getPlanStatusFlag

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


getPlanStatusDefaultValue

public static int getPlanStatusDefaultValue()
Default value for planStatus. Returns PLANSTATUS_NONPLAN


getPlanStatusInvalidValue

public static int getPlanStatusInvalidValue()
Invalid value for planStatus. Returns -1


getPlanStatusPrintValue

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


getPlanStatusFieldPrintValue

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


getPlanStatusRange

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


getPlanStatusValidityCheck

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


getPlanStatusMetatype

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


getCurrPlanOffset

public int getCurrPlanOffset()
Accessor for currPlanOffset


setCurrPlanOffset

public void setCurrPlanOffset(int currPlanOffset)
Mutator for currPlanOffset


currPlanOffsetValueToLabel

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


currPlanOffsetLabelToValue

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


getCurrPlanOffsetPrintVals

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


getCurrPlanOffsetKeyVals

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


getCurrPlanOffsetActualVals

public static java.lang.String[] getCurrPlanOffsetActualVals()
Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.


currPlanOffsetPrint2Key

public static java.lang.String currPlanOffsetPrint2Key(java.lang.String printVal)
Utility method to transform a print value for this field into a key value. See the getCurrPlanOffsetPrintVals and getCurrPlanOffsetKeyVals methods for details.


currPlanOffsetPrint2Actual

public static java.lang.String currPlanOffsetPrint2Actual(java.lang.String printVal)
Utility method to transform a print value for this field into an actual value. See the getCurrPlanOffsetPrintVals and getCurrPlanOffsetActualVals methods for details.


currPlanOffsetActual2Print

public static java.lang.String currPlanOffsetActual2Print(java.lang.String actualVal)
Utility method to transform an actual value for this field into a print value. See the getCurrPlanOffsetActualVals and getCurrPlanOffsetPrintVals methods for details.


getCurrPlanOffsetEnumSummary

public static java.lang.String getCurrPlanOffsetEnumSummary()
Return a single String summary of the possible enum values for debug and similar purposes.


getCurrPlanOffsetFlag

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


getCurrPlanOffsetDefaultValue

public static int getCurrPlanOffsetDefaultValue()
Default value for currPlanOffset. Returns CURRPLANOFFSET_BEFORE


getCurrPlanOffsetInvalidValue

public static int getCurrPlanOffsetInvalidValue()
Invalid value for currPlanOffset. Returns -1


getCurrPlanOffsetPrintValue

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


getCurrPlanOffsetFieldPrintValue

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


getCurrPlanOffsetRange

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


getCurrPlanOffsetValidityCheck

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


getCurrPlanOffsetMetatype

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


getAssignedTo

public int getAssignedTo()
Accessor for assignedTo


setAssignedTo

public void setAssignedTo(int assignedTo)
Mutator for assignedTo


assignedToValueToLabel

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


assignedToLabelToValue

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


getAssignedToPrintVals

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


getAssignedToKeyVals

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


getAssignedToActualVals

public static java.lang.String[] getAssignedToActualVals()
Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.


assignedToPrint2Key

public static java.lang.String assignedToPrint2Key(java.lang.String printVal)
Utility method to transform a print value for this field into a key value. See the getAssignedToPrintVals and getAssignedToKeyVals methods for details.


assignedToPrint2Actual

public static java.lang.String assignedToPrint2Actual(java.lang.String printVal)
Utility method to transform a print value for this field into an actual value. See the getAssignedToPrintVals and getAssignedToActualVals methods for details.


assignedToActual2Print

public static java.lang.String assignedToActual2Print(java.lang.String actualVal)
Utility method to transform an actual value for this field into a print value. See the getAssignedToActualVals and getAssignedToPrintVals methods for details.


getAssignedToEnumSummary

public static java.lang.String getAssignedToEnumSummary()
Return a single String summary of the possible enum values for debug and similar purposes.


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 int getAssignedToDefaultValue()
Default value for assignedTo. Returns ASSIGNEDTO_NOBODY


getAssignedToInvalidValue

public static int getAssignedToInvalidValue()
Invalid value for assignedTo. Returns -1


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


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.


getDueDate

public java.lang.String getDueDate()
Accessor for dueDate


setDueDate

public void setDueDate(java.lang.String dueDate)
Mutator for dueDate


setDueDate

public void setDueDate(java.lang.Object dueDate)
Generic mutator for dueDate


getDueDateFlag

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


getDueDateLengthNorm

public static int getDueDateLengthNorm()
Normal dueDate length is 30 characters


getDueDateLengthMax

public static int getDueDateLengthMax()
Maximum dueDate length is 70 characters


getDueDateDefaultValue

public static java.lang.String getDueDateDefaultValue()
Default value for dueDate. Returns ""


getDueDateInvalidValue

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


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.


getDueColor

public java.lang.String getDueColor()
Accessor for dueColor


setDueColor

public void setDueColor(java.lang.String dueColor)
Mutator for dueColor


setDueColor

public void setDueColor(java.lang.Object dueColor)
Generic mutator for dueColor


getDueColorFlag

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


getDueColorLengthNorm

public static int getDueColorLengthNorm()
Normal dueColor length is 30 characters


getDueColorLengthMax

public static int getDueColorLengthMax()
Maximum dueColor length is 70 characters


getDueColorDefaultValue

public static java.lang.String getDueColorDefaultValue()
Default value for dueColor. Returns ""


getDueColorInvalidValue

public static java.lang.String getDueColorInvalidValue()
Invalid value for dueColor. Returns null


getDueColorPrintValue

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


getDueColorFieldPrintValue

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


getDueColorRange

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


getDueColorValidityCheck

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


getDueColorMetatype

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

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

getCollectionMessage

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

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

getUpdateMessage

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

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

getStructMessage

public org.sandev.basics.structs.SandStructMessage getStructMessage()
Returns a new PlanTreeElement 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.

Specified by:
isEquivalent 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

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.


toString

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


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

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

cloneMessage

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

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

clonePlanTreeElement

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


copyDataFrom

public void copyDataFrom(PlanTreeElement other)
Deep copy all the data from the specified instance. If the other instance is null then this method does nothing.


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