org.sandev.TaskHeap.sandmessages
Class DataManagement

java.lang.Object
  org.sandev.TaskHeap.structs.DataManagementStruct
      org.sandev.TaskHeap.sandmessages.DataManagement

All Implemented Interfaces:

org.sandev.basics.structs.SandInstanceMessage, org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandPersistMessage, org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable

public class DataManagement
extends DataManagementStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable, org.sandev.basics.structs.SandPersistMessage

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.structs.DataManagementStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jul 31, 2008 4:34:15 PM

Field Summary

protected java.util.Date	creationTime An immutable timestamp reflecting the time when this instance first created.
protected int	instanceWriteAccess A transient field for instance modifiability for use in safe concurrent reference situations like caching.
protected java.util.Date	lastAccessedTime A transient field for tracking object access for use in cache tracking and similar situations.
protected java.lang.String	lastModifiedReason A text field describing the reason for the update or add.
protected java.util.Date	lastModifiedTime An immutable timestamp reflecting the time when this instance was last updated.
protected int	recordStatus Initially set to SandPersistMessage.RECORDSTATUS_ACTIVE by the persistence processing on creation, this field is set to RECORDSTATUS_DELETED in response to a SandUpdateMessage ACTION_DELETE.
static int	RECORDSTATUS_ACTIVE Possible value for recordStatus
static int	RECORDSTATUS_ARCHIVED Possible value for recordStatus
static int	RECORDSTATUS_DELETED Possible value for recordStatus
protected long	revisionNumber An immutable version number updated by the persistence processing on each update.
protected long	uniqueID An immutable unique identifier generated by the persistence processing when a SandUpdateMessage ACTION_ADD is sent to a DataManager node instance and processed successfully.

Fields inherited from class org.sandev.TaskHeap.structs.DataManagementStruct

confirmChildren, confirmParents, dumpTasks, exportData, importHeap, publishHeap, tutorial

Fields inherited from interface org.sandev.basics.structs.SandPersistMessage

WRITEACCESS_NORMAL, WRITEACCESS_READONLY

Constructor Summary

DataManagement()
Default constructor calls init.

Method Summary

DataManagement	cloneDataManagement() Make a deep copy of this DataManagement.
org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls cloneDataManagement
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(DataManagement other, boolean deepcopy) Copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.SandInstanceMessage other) Copy the specified field from the given instance.
java.lang.String	debugDump(java.lang.String prefix) Dump this instance into a debug printable string.
void	defaultField(java.lang.String fieldname) Set the specified field to its default value.
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
boolean	fieldsValid() Validate the fields as specified in the SandInstanceMessage interface
org.sandev.basics.structs.SandAttrVal[]	fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
org.sandev.basics.structs.SandCollectionMessage	find(org.sandev.basics.structs.SandQueryMessage sqm) Return a matching collection of all directly contained instances matching the given query.
java.lang.Object	generalAccessor(java.lang.String fieldspec) General field accessor method.
org.sandev.basics.structs.SandAttrVal	generalDereference(java.lang.String fieldspec) General reference field accessor method.
void	generalModifier(int action, java.lang.String field, int index, java.lang.Object val) General mutator method.
java.lang.String[]	getAllFields() Return an array of all fields for this class.
int	getBaseMemoryUse() Return the base memory use for this object.
org.sandev.basics.structs.SandCollectionMessage	getCollectionMessage() Returns a new DataManagementCollection instance
java.lang.String	getConfirmChildren() Accessor for confirmChildren
static java.lang.String	getConfirmChildrenDefaultValue() Default value for confirmChildren.
java.lang.String	getConfirmChildrenFieldPrintValue() Return the print name of the confirmChildren field.
static boolean	getConfirmChildrenFlag(int fieldflag) Field flag accessor.
static java.lang.String	getConfirmChildrenInvalidValue() Invalid value for confirmChildren.
static int	getConfirmChildrenLengthMax() Maximum confirmChildren length is 60 characters
static int	getConfirmChildrenLengthNorm() Normal confirmChildren length is 40 characters
java.lang.String	getConfirmChildrenMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getConfirmChildrenPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getConfirmChildrenRange() Return the range specification for this field
java.lang.String	getConfirmChildrenValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getConfirmParents() Accessor for confirmParents
static java.lang.String	getConfirmParentsDefaultValue() Default value for confirmParents.
java.lang.String	getConfirmParentsFieldPrintValue() Return the print name of the confirmParents field.
static boolean	getConfirmParentsFlag(int fieldflag) Field flag accessor.
static java.lang.String	getConfirmParentsInvalidValue() Invalid value for confirmParents.
static int	getConfirmParentsLengthMax() Maximum confirmParents length is 60 characters
static int	getConfirmParentsLengthNorm() Normal confirmParents length is 40 characters
java.lang.String	getConfirmParentsMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getConfirmParentsPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getConfirmParentsRange() Return the range specification for this field
java.lang.String	getConfirmParentsValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String[]	getContainedMessageFields() Return an array of all contained message fields.
java.util.Date	getCreationTime() Accessor for creationTime
static java.util.Date	getCreationTimeDefaultValue() Default value for creationTime.
java.lang.String	getCreationTimeFieldPrintValue() Return the print name of the creationTime field.
static boolean	getCreationTimeFlag(int fieldflag) Field flag accessor.
static java.util.Date	getCreationTimeInvalidValue() Invalid value for creationTime.
java.lang.String	getCreationTimeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getCreationTimePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getCreationTimeRange() Return the range specification for this field
java.lang.String	getCreationTimeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.util.Date	getCreationTimeWithOffset() Return the date value incorporating the timezone offset specified for the field, if any.
java.lang.String[]	getDisplayFields() Return an array of the summary field names for this class.
java.lang.String[]	getDisplayFieldsPrint() Return an array of the summary field print names for this class.
java.lang.String	getDisplayID() Return the displayID for this message instance
java.lang.String[]	getDisplayValues() Return the values for the summary fields.
java.lang.String[]	getDisplayValues(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Return the values for the summary fields, including dereference expressions.
java.lang.String	getDumpTasks() Accessor for dumpTasks
static java.lang.String	getDumpTasksDefaultValue() Default value for dumpTasks.
java.lang.String	getDumpTasksFieldPrintValue() Return the print name of the dumpTasks field.
static boolean	getDumpTasksFlag(int fieldflag) Field flag accessor.
static java.lang.String	getDumpTasksInvalidValue() Invalid value for dumpTasks.
static int	getDumpTasksLengthMax() Maximum dumpTasks length is 60 characters
static int	getDumpTasksLengthNorm() Normal dumpTasks length is 40 characters
java.lang.String	getDumpTasksMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getDumpTasksPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDumpTasksRange() Return the range specification for this field
java.lang.String	getDumpTasksValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getExportData() Accessor for exportData
static java.lang.String	getExportDataDefaultValue() Default value for exportData.
java.lang.String	getExportDataFieldPrintValue() Return the print name of the exportData field.
static boolean	getExportDataFlag(int fieldflag) Field flag accessor.
static java.lang.String	getExportDataInvalidValue() Invalid value for exportData.
static int	getExportDataLengthMax() Maximum exportData length is 60 characters
static int	getExportDataLengthNorm() Normal exportData length is 40 characters
java.lang.String	getExportDataMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getExportDataPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getExportDataRange() Return the range specification for this field
java.lang.String	getExportDataValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getImportHeap() Accessor for importHeap
static java.lang.String	getImportHeapDefaultValue() Default value for importHeap.
java.lang.String	getImportHeapFieldPrintValue() Return the print name of the importHeap field.
static boolean	getImportHeapFlag(int fieldflag) Field flag accessor.
static java.lang.String	getImportHeapInvalidValue() Invalid value for importHeap.
static int	getImportHeapLengthMax() Maximum importHeap length is 60 characters
static int	getImportHeapLengthNorm() Normal importHeap length is 40 characters
java.lang.String	getImportHeapMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getImportHeapPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getImportHeapRange() Return the range specification for this field
java.lang.String	getImportHeapValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.SandPersistMessage	getInstance(java.lang.String classname, long id) If this instance directly contains the specified instance, then find it and return it.
org.sandev.basics.structs.SandInstanceMessage	getInstance(java.lang.String classname, java.lang.String fieldname, java.lang.String value) If this instance directly contains the specified instance, then find it and return it.
int	getInstanceWriteAccess() Accessor for instanceWriteAccess
static int	getInstanceWriteAccessDefaultValue() Default value for instanceWriteAccess.
java.lang.String	getInstanceWriteAccessFieldPrintValue() Return the print name of the instanceWriteAccess field.
static boolean	getInstanceWriteAccessFlag(int fieldflag) Field flag accessor.
static int	getInstanceWriteAccessInvalidValue() Invalid value for instanceWriteAccess.
java.lang.String	getInstanceWriteAccessMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getInstanceWriteAccessPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getInstanceWriteAccessRange() Return the range specification for this field
java.lang.String	getInstanceWriteAccessValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.util.Date	getLastAccessedTime() Accessor for lastAccessedTime
static java.util.Date	getLastAccessedTimeDefaultValue() Default value for lastAccessedTime.
java.lang.String	getLastAccessedTimeFieldPrintValue() Return the print name of the lastAccessedTime field.
static boolean	getLastAccessedTimeFlag(int fieldflag) Field flag accessor.
static java.util.Date	getLastAccessedTimeInvalidValue() Invalid value for lastAccessedTime.
java.lang.String	getLastAccessedTimeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getLastAccessedTimePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getLastAccessedTimeRange() Return the range specification for this field
java.lang.String	getLastAccessedTimeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.util.Date	getLastAccessedTimeWithOffset() Return the date value incorporating the timezone offset specified for the field, if any.
java.lang.String	getLastModifiedReason() Accessor for lastModifiedReason
static java.lang.String	getLastModifiedReasonDefaultValue() Default value for lastModifiedReason.
java.lang.String	getLastModifiedReasonFieldPrintValue() Return the print name of the lastModifiedReason field.
static boolean	getLastModifiedReasonFlag(int fieldflag) Field flag accessor.
static java.lang.String	getLastModifiedReasonInvalidValue() Invalid value for lastModifiedReason.
static int	getLastModifiedReasonLengthMax() Maximum lastModifiedReason length is 70 characters
static int	getLastModifiedReasonLengthNorm() Normal lastModifiedReason length is 30 characters
java.lang.String	getLastModifiedReasonMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getLastModifiedReasonPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getLastModifiedReasonRange() Return the range specification for this field
java.lang.String	getLastModifiedReasonValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.util.Date	getLastModifiedTime() Accessor for lastModifiedTime
static java.util.Date	getLastModifiedTimeDefaultValue() Default value for lastModifiedTime.
java.lang.String	getLastModifiedTimeFieldPrintValue() Return the print name of the lastModifiedTime field.
static boolean	getLastModifiedTimeFlag(int fieldflag) Field flag accessor.
static java.util.Date	getLastModifiedTimeInvalidValue() Invalid value for lastModifiedTime.
java.lang.String	getLastModifiedTimeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getLastModifiedTimePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getLastModifiedTimeRange() Return the range specification for this field
java.lang.String	getLastModifiedTimeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.util.Date	getLastModifiedTimeWithOffset() Return the date value incorporating the timezone offset specified for the field, if any.
java.lang.String	getLayoutXML() Return the fieldlayout XML or null if not defined.
java.lang.String	getPrintname() Return the printname of the class
java.lang.String	getPrintnameForField(java.lang.String fieldname) Given a fieldname, return its declared printname if declared.
java.lang.String	getPublishHeap() Accessor for publishHeap
static java.lang.String	getPublishHeapDefaultValue() Default value for publishHeap.
java.lang.String	getPublishHeapFieldPrintValue() Return the print name of the publishHeap field.
static boolean	getPublishHeapFlag(int fieldflag) Field flag accessor.
static java.lang.String	getPublishHeapInvalidValue() Invalid value for publishHeap.
static int	getPublishHeapLengthMax() Maximum publishHeap length is 60 characters
static int	getPublishHeapLengthNorm() Normal publishHeap length is 40 characters
java.lang.String	getPublishHeapMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getPublishHeapPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getPublishHeapRange() Return the range specification for this field
java.lang.String	getPublishHeapValidityCheck() 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 DataManagementQuery instance
int	getRecordStatus() Accessor for recordStatus
static java.lang.String[]	getRecordStatusActualVals() Return an array of the possible values for this field as Strings.
static int	getRecordStatusDefaultValue() Default value for recordStatus.
static java.lang.String	getRecordStatusEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getRecordStatusFieldPrintValue() Return the print name of the recordStatus field.
static boolean	getRecordStatusFlag(int fieldflag) Field flag accessor.
static int	getRecordStatusInvalidValue() Invalid value for recordStatus.
static java.lang.String[]	getRecordStatusKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getRecordStatusMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getRecordStatusPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getRecordStatusPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getRecordStatusRange() Return the range specification for this field
java.lang.String	getRecordStatusValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
long	getRevisionNumber() Accessor for revisionNumber
static long	getRevisionNumberDefaultValue() Default value for revisionNumber.
java.lang.String	getRevisionNumberFieldPrintValue() Return the print name of the revisionNumber field.
static boolean	getRevisionNumberFlag(int fieldflag) Field flag accessor.
static long	getRevisionNumberInvalidValue() Invalid value for revisionNumber.
java.lang.String	getRevisionNumberMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getRevisionNumberPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getRevisionNumberRange() Return the range specification for this field
java.lang.String	getRevisionNumberValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getShortName() Returns the unqualified name of this message.
org.sandev.basics.structs.SandStructMessage	getStructMessage() Returns a new DataManagement instance
java.lang.String	getTutorial() Accessor for tutorial
static java.lang.String	getTutorialDefaultValue() Default value for tutorial.
java.lang.String	getTutorialFieldPrintValue() Return the print name of the tutorial field.
static boolean	getTutorialFlag(int fieldflag) Field flag accessor.
static java.lang.String	getTutorialInvalidValue() Invalid value for tutorial.
static int	getTutorialLengthMax() Maximum tutorial length is 60 characters
static int	getTutorialLengthNorm() Normal tutorial length is 40 characters
java.lang.String	getTutorialMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getTutorialPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getTutorialRange() Return the range specification for this field
java.lang.String	getTutorialValidityCheck() 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 DataManagementUpdate instance
java.lang.String	getValueForFieldName(java.lang.String fieldname, org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Returns the print representation of the value of the specified field, or the given default value if innaccessible.
void	init() Initialize all fields to their default values
boolean	isEquivalent(org.sandev.basics.structs.SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
static java.lang.String	recordStatusActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	recordStatusLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	recordStatusLabelToValueStatic(java.lang.String label)
static java.lang.String	recordStatusPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	recordStatusPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	recordStatusValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	recordStatusValueToLabelStatic(int val)
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, org.sandev.basics.util.IDLookup idlookup, org.sandev.basics.util.NameLookup namelookup, org.sandev.basics.util.AuthUser au) Validate the references as specified in the Resolvable interface.
void	setConfirmChildren(java.lang.Object confirmChildren) Generic mutator for confirmChildren
void	setConfirmChildren(java.lang.String confirmChildren) Mutator for confirmChildren
void	setConfirmParents(java.lang.Object confirmParents) Generic mutator for confirmParents
void	setConfirmParents(java.lang.String confirmParents) Mutator for confirmParents
void	setCreationTime(java.util.Date creationTime) Mutator for creationTime
void	setCreationTime(java.lang.Object creationTime) Generic mutator for creationTime
void	setCreationTimeWithOffset(java.util.Date val) Set the date value incorporating the timezone offset specified for the field, if any.
void	setDumpTasks(java.lang.Object dumpTasks) Generic mutator for dumpTasks
void	setDumpTasks(java.lang.String dumpTasks) Mutator for dumpTasks
void	setExportData(java.lang.Object exportData) Generic mutator for exportData
void	setExportData(java.lang.String exportData) Mutator for exportData
void	setImportHeap(java.lang.Object importHeap) Generic mutator for importHeap
void	setImportHeap(java.lang.String importHeap) Mutator for importHeap
void	setInstanceWriteAccess(int instanceWriteAccess) Mutator for instanceWriteAccess
void	setLastAccessedTime(java.util.Date lastAccessedTime) Mutator for lastAccessedTime
void	setLastAccessedTime(java.lang.Object lastAccessedTime) Generic mutator for lastAccessedTime
void	setLastAccessedTimeWithOffset(java.util.Date val) Set the date value incorporating the timezone offset specified for the field, if any.
void	setLastModifiedReason(java.lang.Object lastModifiedReason) Generic mutator for lastModifiedReason
void	setLastModifiedReason(java.lang.String lastModifiedReason) Mutator for lastModifiedReason
void	setLastModifiedTime(java.util.Date lastModifiedTime) Mutator for lastModifiedTime
void	setLastModifiedTime(java.lang.Object lastModifiedTime) Generic mutator for lastModifiedTime
void	setLastModifiedTimeWithOffset(java.util.Date val) Set the date value incorporating the timezone offset specified for the field, if any.
void	setPublishHeap(java.lang.Object publishHeap) Generic mutator for publishHeap
void	setPublishHeap(java.lang.String publishHeap) Mutator for publishHeap
void	setRecordStatus(int recordStatus) Mutator for recordStatus
void	setRevisionNumber(long revisionNumber) Mutator for revisionNumber
void	setTutorial(java.lang.Object tutorial) Generic mutator for tutorial
void	setTutorial(java.lang.String tutorial) Mutator for tutorial
void	setUniqueID(long uniqueID) Mutator for uniqueID
DataManagement	shallowCopy() Make a shallow copy of this DataManagement.
java.lang.String	toString() Return a string representation of this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

uniqueID

protected long uniqueID

An immutable unique identifier generated by the persistence processing when a SandUpdateMessage ACTION_ADD is sent to a DataManager node instance and processed successfully.

creationTime

protected java.util.Date creationTime

An immutable timestamp reflecting the time when this instance first created. The creationTime is when the instance was first persisted.

lastModifiedTime

protected java.util.Date lastModifiedTime

An immutable timestamp reflecting the time when this instance was last updated. This is set by the persistence processing when the updated instance information is persisted.

lastModifiedReason

protected java.lang.String lastModifiedReason

A text field describing the reason for the update or add. The text can be entered manually by the user, or generated by the application, or a combination of both.

revisionNumber

protected long revisionNumber

An immutable version number updated by the persistence processing on each update. Starts at 1 on initial creation.

lastAccessedTime

protected transient java.util.Date lastAccessedTime

A transient field for tracking object access for use in cache tracking and similar situations.

instanceWriteAccess

protected transient int instanceWriteAccess

A transient field for instance modifiability for use in safe concurrent reference situations like caching.

recordStatus

protected int recordStatus

Initially set to SandPersistMessage.RECORDSTATUS_ACTIVE by the persistence processing on creation, this field is set to RECORDSTATUS_DELETED in response to a SandUpdateMessage ACTION_DELETE. The DataManager will only access persistent information for RECORDSTATUS_ACTIVE unless processing object history. RECORDSTATUS_ARCHIVED is provided to indicate existent data that has been moved offline.

RECORDSTATUS_ACTIVE

public static final int RECORDSTATUS_ACTIVE

Possible value for recordStatus

See Also:

Constant Field Values

RECORDSTATUS_DELETED

public static final int RECORDSTATUS_DELETED

Possible value for recordStatus

See Also:

Constant Field Values

RECORDSTATUS_ARCHIVED

public static final int RECORDSTATUS_ARCHIVED

Possible value for recordStatus

See Also:

Constant Field Values

Constructor Detail

DataManagement

public DataManagement()

Default constructor calls init.

Method Detail

getPrintname

public java.lang.String getPrintname()

Return the printname of the class

Specified by:

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

fieldHasFlag

public boolean fieldHasFlag(java.lang.String fieldname,
                            int fieldflag)

Return true if the named field declares the indicated flag, false otherwise. See the FIELDFLAG* constants in SandInstanceMessage for supported fieldflag values.

Specified by:

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

getPublishHeap

public java.lang.String getPublishHeap()

Accessor for publishHeap

setPublishHeap

public void setPublishHeap(java.lang.String publishHeap)

Mutator for publishHeap

setPublishHeap

public void setPublishHeap(java.lang.Object publishHeap)

Generic mutator for publishHeap

getPublishHeapFlag

public static boolean getPublishHeapFlag(int fieldflag)

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

getPublishHeapLengthNorm

public static int getPublishHeapLengthNorm()

Normal publishHeap length is 40 characters

getPublishHeapLengthMax

public static int getPublishHeapLengthMax()

Maximum publishHeap length is 60 characters

getPublishHeapDefaultValue

public static java.lang.String getPublishHeapDefaultValue()

Default value for publishHeap. Returns ""

getPublishHeapInvalidValue

public static java.lang.String getPublishHeapInvalidValue()

Invalid value for publishHeap. Returns null

getPublishHeapPrintValue

public java.lang.String getPublishHeapPrintValue()

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.

getPublishHeapFieldPrintValue

public java.lang.String getPublishHeapFieldPrintValue()

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

getPublishHeapRange

public java.lang.String getPublishHeapRange()

Return the range specification for this field

getPublishHeapValidityCheck

public java.lang.String getPublishHeapValidityCheck()

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.

getPublishHeapMetatype

public java.lang.String getPublishHeapMetatype()

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

getExportData

public java.lang.String getExportData()

Accessor for exportData

setExportData

public void setExportData(java.lang.String exportData)

Mutator for exportData

setExportData

public void setExportData(java.lang.Object exportData)

Generic mutator for exportData

getExportDataFlag

public static boolean getExportDataFlag(int fieldflag)

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

getExportDataLengthNorm

public static int getExportDataLengthNorm()

Normal exportData length is 40 characters

getExportDataLengthMax

public static int getExportDataLengthMax()

Maximum exportData length is 60 characters

getExportDataDefaultValue

public static java.lang.String getExportDataDefaultValue()

Default value for exportData. Returns ""

getExportDataInvalidValue

public static java.lang.String getExportDataInvalidValue()

Invalid value for exportData. Returns null

getExportDataPrintValue

public java.lang.String getExportDataPrintValue()

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.

getExportDataFieldPrintValue

public java.lang.String getExportDataFieldPrintValue()

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

getExportDataRange

public java.lang.String getExportDataRange()

Return the range specification for this field

<