|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.sandev.TaskHeap.structs.PlanComponentStruct
org.sandev.TaskHeap.structs.PlanStruct
org.sandev.TaskHeap.sandmessages.Plan
AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.structs.PlanStruct
generator: org.sandev.generator.MessageClassGenerator
time: Dec 2, 2005 6:38:52 PM
| Field Summary | |
protected java.util.Date |
creationTime
An immutable timestamp reflecting the time when this instance first created. |
static int |
EXECUTION_PARALLEL
Possible value for execution |
static int |
EXECUTION_SEQUENTIAL
Possible value for execution |
protected java.lang.String |
lastModifiedReason
A text field describing the reason for the update or add. |
protected java.util.Date |
lastModifiedTime
An immutable timestamp reflecting the time when this instance was last updated. |
protected int |
recordStatus
Initially set to SandPersistMessage.RECORDSTATUS_ACTIVE by the persistence processing on creation, this field is set to RECORDSTATUS_DELETED in response to a SandUpdateMessage ACTION_DELETE. |
static int |
RECORDSTATUS_ACTIVE
Possible value for recordStatus |
static int |
RECORDSTATUS_ARCHIVED
Possible value for recordStatus |
static int |
RECORDSTATUS_DELETED
Possible value for recordStatus |
protected long |
revisionNumber
An immutable version number updated by the persistence processing on each update. |
protected int |
sandTransmissionCount
Counter to aid in tracking receipt of sent messages. |
protected long |
sandTransmitAuthID
The uniqueID of the authorized user of this message. |
protected java.lang.String |
sandTransmitErrorMessage
Text details of the transmission error. |
protected int |
sandTransmitStatus
Status of the message. |
protected long |
uniqueID
An immutable unique identifier generated by the persistence processing when a SandUpdateMessage ACTION_ADD is sent to a DataManager node instance and processed successfully. |
static int |
VISIBILITY_HIDDEN
Possible value for visibility |
static int |
VISIBILITY_INTERNAL
Possible value for visibility |
| Fields inherited from class org.sandev.TaskHeap.structs.PlanStruct |
components, execution, visibility |
| Fields inherited from class org.sandev.TaskHeap.structs.PlanComponentStruct |
description, dueDate, name, notes, parent, resourceID, timeEstimate |
| Fields inherited from interface org.sandev.basics.structs.SandInstanceMessage |
FIELDCHECK_INVALIDVAL, FIELDCHECK_NOTAREF, FIELDCHECK_NOTINRANGE, FIELDCHECK_NULLARRAY, FIELDCHECK_STRINGOVER, FIELDCHECK_UNKNOWNVAL, FIELDFLAG_BINARY, FIELDFLAG_ENCRYPT, FIELDFLAG_INTERNAL, FIELDFLAG_NOECHO, FIELDFLAG_OBFUSCATE, FIELDFLAG_STRINGPERSIST, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET |
| Fields inherited from interface org.sandev.basics.structs.SandTransmitMessage |
APPERROR_NODE_UNAVAILABLE, APPERROR_NODE_UNKNOWN, APPERROR_NODE_UNREACHABLE, STATUS_APPERROR, STATUS_NORMAL, STATUS_SANDERROR, STATUS_SYSERROR |
| Constructor Summary | |
Plan()
Default constructor calls init. |
|
| Method Summary | |
void |
addComponents(long element)
Appends a value to components |
void |
addComponents(long[] elements)
Appends an array of values to components |
void |
addNotes(Note element)
Appends a value to notes |
void |
addNotes(Note[] elements)
Appends an array of values to notes |
void |
clearComponents()
Clears all values from components |
void |
clearNotes()
Clears all values from notes |
org.sandev.basics.structs.SandInstanceMessage |
cloneMessage()
Calls clonePlan |
Plan |
clonePlan()
Make a deep copy of this Plan. |
boolean |
componentsContains(long val)
Returns true if components contains the specified value. |
int |
componentsIndexOf(long val)
Return the index of the specified value in components, or -1 if not found. |
org.sandev.basics.structs.SandInstanceMessage |
convertToSuperstructClass()
Return a new instance of the message associated with the superstruct of this instance. |
void |
copyDataFrom(Plan other)
Deep copy all the data from the specified instance. |
void |
copyFieldValue(java.lang.String fieldName,
org.sandev.basics.structs.SandInstanceMessage other)
Copy the specified field from the given instance. |
java.lang.String |
debugDump(java.lang.String prefix)
Dump this instance into a debug printable string. |
void |
defaultField(java.lang.String fieldname)
Set the specified field to its default value. |
static java.lang.String |
executionActual2Print(java.lang.String actualVal)
Utility method to transform an actual value for this field into a print value. |
int |
executionLabelToValue(java.lang.String label)
Given a label, return the value for it. |
static java.lang.String |
executionPrint2Actual(java.lang.String printVal)
Utility method to transform a print value for this field into an actual value. |
static java.lang.String |
executionPrint2Key(java.lang.String printVal)
Utility method to transform a print value for this field into a key value. |
java.lang.String |
executionValueToLabel(int val)
Given a value, return the declared label for it. |
boolean |
fieldHasFlag(java.lang.String fieldname,
int fieldflag)
Return true if the named field declares the indicated flag, false otherwise. |
boolean |
fieldsValid()
Validate the fields as specified in the SandInstanceMessage interface |
org.sandev.basics.structs.SandAttrVal[] |
fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields)
Validate the fields as specified in the SandInstanceMessage interface |
java.lang.Object |
generalAccessor(java.lang.String fieldspec)
General field accessor method. |
org.sandev.basics.structs.SandAttrVal |
generalDereference(java.lang.String fieldspec)
General reference field accessor method. |
void |
generalModifier(int action,
java.lang.String field,
int index,
java.lang.Object val)
General mutator method. |
java.lang.String[] |
getAllFields()
Return an array of all fields for this class. |
org.sandev.basics.structs.SandCollectionMessage |
getCollectionMessage()
Returns a new PlanCollection instance |
long[] |
getComponents()
Accessor for components |
long |
getComponents(int index)
Returns the element at the specified index. |
static long[] |
getComponentsDefaultValue()
Default value for components. |
static long |
getComponentsElementInvalidValue()
Invalid value for componentselement. |
static boolean |
getComponentsFlag(int fieldflag)
Field flag accessor. |
static long[] |
getComponentsInvalidValue()
Invalid value for components. |
java.lang.String |
getComponentsMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getComponentsRange()
Return the range specification for this field |
java.lang.String |
getComponentsValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
java.util.Date |
getCreationTime()
Accessor for creationTime |
static java.util.Date |
getCreationTimeDefaultValue()
Default value for creationTime. |
java.lang.String |
getCreationTimeFieldPrintValue()
Return the print name of the creationTime field. |
static boolean |
getCreationTimeFlag(int fieldflag)
Field flag accessor. |
static java.util.Date |
getCreationTimeInvalidValue()
Invalid value for creationTime. |
java.lang.String |
getCreationTimeMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getCreationTimePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getCreationTimeRange()
Return the range specification for this field |
java.lang.String |
getCreationTimeValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
java.lang.String |
getDescription()
Accessor for description |
static java.lang.String |
getDescriptionDefaultValue()
Default value for description. |
java.lang.String |
getDescriptionFieldPrintValue()
Return the print name of the description field. |
static boolean |
getDescriptionFlag(int fieldflag)
Field flag accessor. |
static java.lang.String |
getDescriptionInvalidValue()
Invalid value for description. |
static int |
getDescriptionLengthMax()
Maximum description length is 1048576 characters |
static int |
getDescriptionLengthNorm()
Normal description length is 512 characters |
java.lang.String |
getDescriptionMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getDescriptionPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getDescriptionRange()
Return the range specification for this field |
java.lang.String |
getDescriptionValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
java.lang.String[] |
getDisplayFields()
Return an array of the summary field names for this class. |
java.lang.String[] |
getDisplayValues()
Return the values for the summary fields. |
java.lang.String[] |
getDisplayValues(org.sandev.basics.util.IDLookup lookup,
org.sandev.basics.util.AuthUser user,
java.lang.String defaultVal)
Return the values for the summary fields, including dereference expressions. |
java.util.Date |
getDueDate()
Accessor for dueDate |
static java.util.Date |
getDueDateDefaultValue()
Default value for dueDate. |
java.lang.String |
getDueDateFieldPrintValue()
Return the print name of the dueDate field. |
static boolean |
getDueDateFlag(int fieldflag)
Field flag accessor. |
static java.util.Date |
getDueDateInvalidValue()
Invalid value for dueDate. |
java.lang.String |
getDueDateMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getDueDatePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getDueDateRange()
Return the range specification for this field |
java.lang.String |
getDueDateValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
int |
getExecution()
Accessor for execution |
static java.lang.String[] |
getExecutionActualVals()
Return an array of the possible values for this field as Strings. |
static int |
getExecutionDefaultValue()
Default value for execution. |
static java.lang.String |
getExecutionEnumSummary()
Return a single String summary of the possible enum values for debug and similar purposes. |
java.lang.String |
getExecutionFieldPrintValue()
Return the print name of the execution field. |
static boolean |
getExecutionFlag(int fieldflag)
Field flag accessor. |
static int |
getExecutionInvalidValue()
Invalid value for execution. |
static java.lang.String[] |
getExecutionKeyVals()
Return an array of unique keys for the values of this field. |
java.lang.String |
getExecutionMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
static java.lang.String[] |
getExecutionPrintVals()
Return an array of the possible values for this field in display format. |
java.lang.String |
getExecutionPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getExecutionRange()
Return the range specification for this field |
java.lang.String |
getExecutionValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
java.lang.String |
getLastModifiedReason()
Accessor for lastModifiedReason |
static java.lang.String |
getLastModifiedReasonDefaultValue()
Default value for lastModifiedReason. |
java.lang.String |
getLastModifiedReasonFieldPrintValue()
Return the print name of the lastModifiedReason field. |
static boolean |
getLastModifiedReasonFlag(int fieldflag)
Field flag accessor. |
static java.lang.String |
getLastModifiedReasonInvalidValue()
Invalid value for lastModifiedReason. |
static int |
getLastModifiedReasonLengthMax()
Maximum lastModifiedReason length is 70 characters |
static int |
getLastModifiedReasonLengthNorm()
Normal lastModifiedReason length is 30 characters |
java.lang.String |
getLastModifiedReasonMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getLastModifiedReasonPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getLastModifiedReasonRange()
Return the range specification for this field |
java.lang.String |
getLastModifiedReasonValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
java.util.Date |
getLastModifiedTime()
Accessor for lastModifiedTime |
static java.util.Date |
getLastModifiedTimeDefaultValue()
Default value for lastModifiedTime. |
java.lang.String |
getLastModifiedTimeFieldPrintValue()
Return the print name of the lastModifiedTime field. |
static boolean |
getLastModifiedTimeFlag(int fieldflag)
Field flag accessor. |
static java.util.Date |
getLastModifiedTimeInvalidValue()
Invalid value for lastModifiedTime. |
java.lang.String |
getLastModifiedTimeMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getLastModifiedTimePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getLastModifiedTimeRange()
Return the range specification for this field |
java.lang.String |
getLastModifiedTimeValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
java.lang.String |
getName()
Accessor for name |
static java.lang.String |
getNameDefaultValue()
Default value for name. |
java.lang.String |
getNameFieldPrintValue()
Return the print name of the name field. |
static boolean |
getNameFlag(int fieldflag)
Field flag accessor. |
static java.lang.String |
getNameInvalidValue()
Invalid value for name. |
static int |
getNameLengthMax()
Maximum name length is 80 characters |
static int |
getNameLengthNorm()
Normal name length is 30 characters |
java.lang.String |
getNameMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getNamePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getNameRange()
Return the range specification for this field |
java.lang.String |
getNameValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
Note[] |
getNotes()
Accessor for notes |
Note |
getNotes(int index)
Returns the element at the specified index. |
static Note[] |
getNotesDefaultValue()
Default value for notes. |
static Note |
getNotesElementInvalidValue()
Invalid value for noteselement. |
static boolean |
getNotesFlag(int fieldflag)
Field flag accessor. |
static Note[] |
getNotesInvalidValue()
Invalid value for notes. |
static int |
getNotesLengthMax()
Maximum notes length is 1048576 characters |
static int |
getNotesLengthNorm()
Normal notes length is 512 characters |
java.lang.String |
getNotesMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getNotesRange()
Return the range specification for this field |
java.lang.String |
getNotesValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
long |
getParent()
Accessor for parent |
static long |
getParentDefaultValue()
Default value for parent. |
java.lang.String |
getParentFieldPrintValue()
Return the print name of the parent field. |
static boolean |
getParentFlag(int fieldflag)
Field flag accessor. |
static long |
getParentInvalidValue()
Invalid value for parent. |
java.lang.String |
getParentMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getParentPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getParentRange()
Return the range specification for this field |
java.lang.String |
getParentValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
org.sandev.basics.structs.SandQueryMessage |
getQueryMessage()
Returns a new PlanQuery instance |
int |
getRecordStatus()
Accessor for recordStatus |
static java.lang.String[] |
getRecordStatusActualVals()
Return an array of the possible values for this field as Strings. |
static int |
getRecordStatusDefaultValue()
Default value for recordStatus. |
static java.lang.String |
getRecordStatusEnumSummary()
Return a single String summary of the possible enum values for debug and similar purposes. |
java.lang.String |
getRecordStatusFieldPrintValue()
Return the print name of the recordStatus field. |
static boolean |
getRecordStatusFlag(int fieldflag)
Field flag accessor. |
static int |
getRecordStatusInvalidValue()
Invalid value for recordStatus. |
static java.lang.String[] |
getRecordStatusKeyVals()
Return an array of unique keys for the values of this field. |
java.lang.String |
getRecordStatusMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
static java.lang.String[] |
getRecordStatusPrintVals()
Return an array of the possible values for this field in display format. |
java.lang.String |
getRecordStatusPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getRecordStatusRange()
Return the range specification for this field |
java.lang.String |
getRecordStatusValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
long |
getResourceID()
Accessor for resourceID |
static long |
getResourceIDDefaultValue()
Default value for resourceID. |
java.lang.String |
getResourceIDFieldPrintValue()
Return the print name of the resourceID field. |
static boolean |
getResourceIDFlag(int fieldflag)
Field flag accessor. |
static long |
getResourceIDInvalidValue()
Invalid value for resourceID. |
java.lang.String |
getResourceIDMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getResourceIDPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getResourceIDRange()
Return the range specification for this field |
java.lang.String |
getResourceIDValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
long |
getRevisionNumber()
Accessor for revisionNumber |
static long |
getRevisionNumberDefaultValue()
Default value for revisionNumber. |
java.lang.String |
getRevisionNumberFieldPrintValue()
Return the print name of the revisionNumber field. |
static boolean |
getRevisionNumberFlag(int fieldflag)
Field flag accessor. |
static long |
getRevisionNumberInvalidValue()
Invalid value for revisionNumber. |
java.lang.String |
getRevisionNumberMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getRevisionNumberPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getRevisionNumberRange()
Return the range specification for this field |
java.lang.String |
getRevisionNumberValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
int |
getSandTransmissionCount()
Accessor for sandTransmissionCount |
static int |
getSandTransmissionCountDefaultValue()
Default value for sandTransmissionCount. |
java.lang.String |
getSandTransmissionCountFieldPrintValue()
Return the print name of the sandTransmissionCount field. |
static boolean |
getSandTransmissionCountFlag(int fieldflag)
Field flag accessor. |
static int |
getSandTransmissionCountInvalidValue()
Invalid value for sandTransmissionCount. |
java.lang.String |
getSandTransmissionCountMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getSandTransmissionCountPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getSandTransmissionCountRange()
Return the range specification for this field |
java.lang.String |
getSandTransmissionCountValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
long |
getSandTransmitAuthID()
Accessor for sandTransmitAuthID |
static long |
getSandTransmitAuthIDDefaultValue()
Default value for sandTransmitAuthID. |
java.lang.String |
getSandTransmitAuthIDFieldPrintValue()
Return the print name of the sandTransmitAuthID field. |
static boolean |
getSandTransmitAuthIDFlag(int fieldflag)
Field flag accessor. |
static long |
getSandTransmitAuthIDInvalidValue()
Invalid value for sandTransmitAuthID. |
java.lang.String |
getSandTransmitAuthIDMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getSandTransmitAuthIDPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getSandTransmitAuthIDRange()
Return the range specification for this field |
java.lang.String |
getSandTransmitAuthIDValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
java.lang.String |
getSandTransmitErrorMessage()
Accessor for sandTransmitErrorMessage |
static java.lang.String |
getSandTransmitErrorMessageDefaultValue()
Default value for sandTransmitErrorMessage. |
java.lang.String |
getSandTransmitErrorMessageFieldPrintValue()
Return the print name of the sandTransmitErrorMessage field. |
static boolean |
getSandTransmitErrorMessageFlag(int fieldflag)
Field flag accessor. |
static java.lang.String |
getSandTransmitErrorMessageInvalidValue()
Invalid value for sandTransmitErrorMessage. |
static int |
getSandTransmitErrorMessageLengthMax()
Maximum sandTransmitErrorMessage length is 70 characters |
static int |
getSandTransmitErrorMessageLengthNorm()
Normal sandTransmitErrorMessage length is 30 characters |
java.lang.String |
getSandTransmitErrorMessageMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getSandTransmitErrorMessagePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getSandTransmitErrorMessageRange()
Return the range specification for this field |
java.lang.String |
getSandTransmitErrorMessageValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
int |
getSandTransmitStatus()
Accessor for sandTransmitStatus |
static int |
getSandTransmitStatusDefaultValue()
Default value for sandTransmitStatus. |
java.lang.String |
getSandTransmitStatusFieldPrintValue()
Return the print name of the sandTransmitStatus field. |
static boolean |
getSandTransmitStatusFlag(int fieldflag)
Field flag accessor. |
static int |
getSandTransmitStatusInvalidValue()
Invalid value for sandTransmitStatus. |
java.lang.String |
getSandTransmitStatusMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getSandTransmitStatusPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getSandTransmitStatusRange()
Return the range specification for this field |
java.lang.String |
getSandTransmitStatusValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
java.lang.String |
getShortName()
Returns the unqualified name of this message. |
org.sandev.basics.structs.SandStructMessage |
getStructMessage()
Returns a new Plan instance |
long |
getTimeEstimate()
Accessor for timeEstimate |
static long |
getTimeEstimateDefaultValue()
Default value for timeEstimate. |
java.lang.String |
getTimeEstimateFieldPrintValue()
Return the print name of the timeEstimate field. |
static boolean |
getTimeEstimateFlag(int fieldflag)
Field flag accessor. |
static long |
getTimeEstimateInvalidValue()
Invalid value for timeEstimate. |
java.lang.String |
getTimeEstimateMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getTimeEstimatePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getTimeEstimateRange()
Return the range specification for this field |
java.lang.String |
getTimeEstimateValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
long |
getUniqueID()
Accessor for uniqueID |
static long |
getUniqueIDDefaultValue()
Default value for uniqueID. |
java.lang.String |
getUniqueIDFieldPrintValue()
Return the print name of the uniqueID field. |
static boolean |
getUniqueIDFlag(int fieldflag)
Field flag accessor. |
static long |
getUniqueIDInvalidValue()
Invalid value for uniqueID. |
java.lang.String |
getUniqueIDMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getUniqueIDPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getUniqueIDRange()
Return the range specification for this field |
java.lang.String |
getUniqueIDValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
org.sandev.basics.structs.SandUpdateMessage |
getUpdateMessage()
Returns a new PlanUpdate instance |
java.lang.String |
getValueForFieldName(java.lang.String fieldname,
org.sandev.basics.util.IDLookup lookup,
org.sandev.basics.util.AuthUser user,
java.lang.String defaultVal)
Returns the print representation of the value of the specified field, or the given default value if innaccessible. |
int |
getVisibility()
Accessor for visibility |
static java.lang.String[] |
getVisibilityActualVals()
Return an array of the possible values for this field as Strings. |
static int |
getVisibilityDefaultValue()
Default value for visibility. |
static java.lang.String |
getVisibilityEnumSummary()
Return a single String summary of the possible enum values for debug and similar purposes. |
java.lang.String |
getVisibilityFieldPrintValue()
Return the print name of the visibility field. |
static boolean |
getVisibilityFlag(int fieldflag)
Field flag accessor. |
static int |
getVisibilityInvalidValue()
Invalid value for visibility. |
static java.lang.String[] |
getVisibilityKeyVals()
Return an array of unique keys for the values of this field. |
java.lang.String |
getVisibilityMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
static java.lang.String[] |
getVisibilityPrintVals()
Return an array of the possible values for this field in display format. |
java.lang.String |
getVisibilityPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getVisibilityRange()
Return the range specification for this field |
java.lang.String |
getVisibilityValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
void |
init()
Initialize all fields to their default values |
void |
insertComponents(int index,
long value)
Insert the specified element at the specified index. |
void |
insertNotes(int index,
Note value)
Insert the specified element at the specified index. |
boolean |
isEquivalent(org.sandev.basics.structs.SandMessage sm)
Declared field equivalence check as specified by the SandMessage interface. |
boolean |
notesContains(Note val)
Returns true if notes contains the specified value. |
int |
notesIndexOf(Note val)
Return the index of the specified value in notes, or -1 if not found. |
static java.lang.String |
recordStatusActual2Print(java.lang.String actualVal)
Utility method to transform an actual value for this field into a print value. |
int |
recordStatusLabelToValue(java.lang.String label)
Given a label, return the value for it. |
static java.lang.String |
recordStatusPrint2Actual(java.lang.String printVal)
Utility method to transform a print value for this field into an actual value. |
static java.lang.String |
recordStatusPrint2Key(java.lang.String printVal)
Utility method to transform a print value for this field into a key value. |
java.lang.String |
recordStatusValueToLabel(int val)
Given a value, return the declared label for it. |
java.lang.String[] |
referenceValidate(java.lang.String[] locations,
java.lang.String prefix,
org.sandev.basics.util.IDLookup idlookup,
org.sandev.basics.util.NameLookup namelookup,
org.sandev.basics.util.AuthUser au)
Validate the references as specified in the Resolvable interface. |
long |
removeComponents(int index)
Remove the element at the specified index and return it. |
boolean |
removeComponentsValue(long value)
Removes the given element from components. |
Note |
removeNotes(int index)
Remove the element at the specified index and return it. |
boolean |
removeNotesValue(Note value)
Removes the given element from notes. |
| |