org.sandev.basics.sandmessages
Class DataImportExport

java.lang.Object
  org.sandev.basics.structs.DataImportExportStruct
      org.sandev.basics.sandmessages.DataImportExport

All Implemented Interfaces:

Resolvable, SandInstanceMessage, SandMessage, SandStructMessage, SandTransmitMessage

public class DataImportExport

extends DataImportExportStruct

implements SandStructMessage, Resolvable, SandTransmitMessage

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.structs.DataImportExportStruct
generator: org.sandev.generator.MessageClassGenerator
time: Dec 2, 2005 6:38:50 PM

Field Summary

static int	ACTION_EXPORT Indicates the data should be exported.
static int	ACTION_IMPORT Indicates the data should be imported.
static int	ACTION_RESTORE Indicates the data should be imported, with the lastUpdateTime for each entry preserved.
static int	RESOLUTION_ABORT If an instance exists, and is different than the data we are importing, then abort the entire import operation and rollback any changes.
static int	RESOLUTION_FAIL If an instance exists, but is different than what is specified in the import data, then stop processing and return the two conflicting instances.
static int	RESOLUTION_MERGE If an instance exists, but is different than what is specified in the import data, then leave it alone.
static int	RESOLUTION_OVERWRITE Overwrite any existing data with the the import data.
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.

Fields inherited from class org.sandev.basics.structs.DataImportExportStruct

action, dataDescriptions, existingInstance, importInstance, maxReturnOverride, resolution, source

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

DataImportExport()
Default constructor calls init.

Method Summary

static java.lang.String	actionActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	actionLabelToValue(java.lang.String label) Given a label, return the value for it.
static java.lang.String	actionPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	actionPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	actionValueToLabel(int val) Given a value, return the declared label for it.
void	addDataDescriptions(SandQueryMessage element) Appends a value to dataDescriptions
void	addDataDescriptions(SandQueryMessage[] elements) Appends an array of values to dataDescriptions
void	clearDataDescriptions() Clears all values from dataDescriptions
DataImportExport	cloneDataImportExport() Make a deep copy of this DataImportExport.
SandInstanceMessage	cloneMessage() Calls cloneDataImportExport
SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(DataImportExport other) Deep copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, SandInstanceMessage other) Copy the specified field from the given instance.
boolean	dataDescriptionsContains(SandQueryMessage val) Returns true if dataDescriptions contains the specified value.
int	dataDescriptionsIndexOf(SandQueryMessage val) Return the index of the specified value in dataDescriptions, or -1 if not found.
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
SandAttrVal[]	fieldValidate(SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
java.lang.Object	generalAccessor(java.lang.String fieldspec) General field accessor method.
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.
int	getAction() Accessor for action
static java.lang.String[]	getActionActualVals() Return an array of the possible values for this field as Strings.
static int	getActionDefaultValue() Default value for action.
static java.lang.String	getActionEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getActionFieldPrintValue() Return the print name of the action field.
static boolean	getActionFlag(int fieldflag) Field flag accessor.
static int	getActionInvalidValue() Invalid value for action.
static java.lang.String[]	getActionKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getActionMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getActionPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getActionPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getActionRange() Return the range specification for this field
java.lang.String	getActionValidityCheck() 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.
SandCollectionMessage	getCollectionMessage() Returns null
SandQueryMessage[]	getDataDescriptions() Accessor for dataDescriptions
SandQueryMessage	getDataDescriptions(int index) Returns the element at the specified index.
static SandQueryMessage[]	getDataDescriptionsDefaultValue() Default value for dataDescriptions.
static SandQueryMessage	getDataDescriptionsElementInvalidValue() Invalid value for dataDescriptionselement.
static boolean	getDataDescriptionsFlag(int fieldflag) Field flag accessor.
static SandQueryMessage[]	getDataDescriptionsInvalidValue() Invalid value for dataDescriptions.
java.lang.String	getDataDescriptionsMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getDataDescriptionsRange() Return the range specification for this field
java.lang.String	getDataDescriptionsValidityCheck() 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(IDLookup lookup, AuthUser user, java.lang.String defaultVal) Return the values for the summary fields, including dereference expressions.
SandStructMessage	getExistingInstance() Accessor for existingInstance
static SandStructMessage	getExistingInstanceDefaultValue() Default value for existingInstance.
java.lang.String	getExistingInstanceFieldPrintValue() Return the print name of the existingInstance field.
static boolean	getExistingInstanceFlag(int fieldflag) Field flag accessor.
static SandStructMessage	getExistingInstanceInvalidValue() Invalid value for existingInstance.
java.lang.String	getExistingInstanceMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getExistingInstancePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getExistingInstanceRange() Return the range specification for this field
java.lang.String	getExistingInstanceValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandStructMessage	getImportInstance() Accessor for importInstance
static SandStructMessage	getImportInstanceDefaultValue() Default value for importInstance.
java.lang.String	getImportInstanceFieldPrintValue() Return the print name of the importInstance field.
static boolean	getImportInstanceFlag(int fieldflag) Field flag accessor.
static SandStructMessage	getImportInstanceInvalidValue() Invalid value for importInstance.
java.lang.String	getImportInstanceMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getImportInstancePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getImportInstanceRange() Return the range specification for this field
java.lang.String	getImportInstanceValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getMaxReturnOverride() Accessor for maxReturnOverride
static int	getMaxReturnOverrideDefaultValue() Default value for maxReturnOverride.
java.lang.String	getMaxReturnOverrideFieldPrintValue() Return the print name of the maxReturnOverride field.
static boolean	getMaxReturnOverrideFlag(int fieldflag) Field flag accessor.
static int	getMaxReturnOverrideInvalidValue() Invalid value for maxReturnOverride.
java.lang.String	getMaxReturnOverrideMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getMaxReturnOverridePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getMaxReturnOverrideRange() Return the range specification for this field
java.lang.String	getMaxReturnOverrideValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandQueryMessage	getQueryMessage() Returns null
int	getResolution() Accessor for resolution
static java.lang.String[]	getResolutionActualVals() Return an array of the possible values for this field as Strings.
static int	getResolutionDefaultValue() Default value for resolution.
static java.lang.String	getResolutionEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getResolutionFieldPrintValue() Return the print name of the resolution field.
static boolean	getResolutionFlag(int fieldflag) Field flag accessor.
static int	getResolutionInvalidValue() Invalid value for resolution.
static java.lang.String[]	getResolutionKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getResolutionMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getResolutionPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getResolutionPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getResolutionRange() Return the range specification for this field
java.lang.String	getResolutionValidityCheck() 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.
java.lang.String	getSource() Accessor for source
static java.lang.String	getSourceDefaultValue() Default value for source.
java.lang.String	getSourceFieldPrintValue() Return the print name of the source field.
static boolean	getSourceFlag(int fieldflag) Field flag accessor.
static java.lang.String	getSourceInvalidValue() Invalid value for source.
static int	getSourceLengthMax() Maximum source length is 70 characters
static int	getSourceLengthNorm() Normal source length is 30 characters
java.lang.String	getSourceMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSourcePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSourceRange() Return the range specification for this field
java.lang.String	getSourceValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandStructMessage	getStructMessage() Returns a new DataImportExport instance
SandUpdateMessage	getUpdateMessage() Returns null
java.lang.String	getValueForFieldName(java.lang.String fieldname, IDLookup lookup, AuthUser user, java.lang.String defaultVal) Returns the print representation of the value of the specified field, or the given default value if innaccessible.
boolean	hasResolutionAbort() boolean accessor for resolution value
boolean	hasResolutionFail() boolean accessor for resolution value
boolean	hasResolutionMerge() boolean accessor for resolution value
boolean	hasResolutionOverwrite() boolean accessor for resolution value
void	init() Initialize all fields to their default values
void	insertDataDescriptions(int index, SandQueryMessage value) Insert the specified element at the specified index.
boolean	isActionExport() boolean accessor for action value
boolean	isActionImport() boolean accessor for action value
boolean	isActionRestore() boolean accessor for action value
boolean	isEquivalent(SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, IDLookup idlookup, NameLookup namelookup, AuthUser au) Validate the references as specified in the Resolvable interface.
SandQueryMessage	removeDataDescriptions(int index) Remove the element at the specified index and return it.
boolean	removeDataDescriptionsValue(SandQueryMessage value) Removes the given element from dataDescriptions.
static java.lang.String	resolutionActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	resolutionLabelToValue(java.lang.String label) Given a label, return the value for it.
static java.lang.String	resolutionPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	resolutionPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	resolutionValueToLabel(int val) Given a value, return the declared label for it.
void	setAction(int action) Mutator for action
void	setDataDescriptions(int index, SandQueryMessage value) Set the value at the index specified.
void	setDataDescriptions(java.lang.Object[] dataDescriptions) Generic mutator for dataDescriptions
void	setDataDescriptions(SandQueryMessage[] dataDescriptions) Mutator for dataDescriptions
void	setExistingInstance(java.lang.Object existingInstance) Generic mutator for existingInstance
void	setExistingInstance(SandStructMessage existingInstance) Mutator for existingInstance
void	setImportInstance(java.lang.Object importInstance) Generic mutator for importInstance
void	setImportInstance(SandStructMessage importInstance) Mutator for importInstance
void	setMaxReturnOverride(int maxReturnOverride) Mutator for maxReturnOverride
void	setResolution(int resolution) Mutator for resolution
void	setSandTransmissionCount(int sandTransmissionCount) Mutator for sandTransmissionCount
void	setSandTransmitAuthID(long sandTransmitAuthID) Mutator for sandTransmitAuthID
void	setSandTransmitErrorMessage(java.lang.Object sandTransmitErrorMessage) Generic mutator for sandTransmitErrorMessage
void	setSandTransmitErrorMessage(java.lang.String sandTransmitErrorMessage) Mutator for sandTransmitErrorMessage
void	setSandTransmitStatus(int sandTransmitStatus) Mutator for sandTransmitStatus
void	setSource(java.lang.Object source) Generic mutator for source
void	setSource(java.lang.String source) Mutator for source
int	sizeofDataDescriptions() Returns the size of dataDescriptions.
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

ACTION_EXPORT

public static final int ACTION_EXPORT

Indicates the data should be exported.

See Also:

Constant Field Values

ACTION_IMPORT

public static final int ACTION_IMPORT

Indicates the data should be imported.

See Also:

Constant Field Values

ACTION_RESTORE

public static final int ACTION_RESTORE

Indicates the data should be imported, with the lastUpdateTime for each entry preserved.

See Also:

Constant Field Values

RESOLUTION_ABORT

public static final int RESOLUTION_ABORT

If an instance exists, and is different than the data we are importing, then abort the entire import operation and rollback any changes.

See Also:

Constant Field Values

RESOLUTION_OVERWRITE

public static final int RESOLUTION_OVERWRITE

Overwrite any existing data with the the import data.

See Also:

Constant Field Values

RESOLUTION_MERGE

public static final int RESOLUTION_MERGE

If an instance exists, but is different than what is specified in the import data, then leave it alone. This assumes that the import data is older and should not cause changes to what is currently around. It is up to the application to ensure that the resulting import does not result in an inconsistent data state.

See Also:

Constant Field Values

RESOLUTION_FAIL

public static final int RESOLUTION_FAIL

If an instance exists, but is different than what is specified in the import data, then stop processing and return the two conflicting instances. The application can then choose to resolve the situation however it wants and presumably retry the import operation. This is essentially a manual merge.

See Also:

Constant Field Values

sandTransmitStatus

protected int sandTransmitStatus

Status of the message. Possible values are defined in SandTransmitMessage.

sandTransmitErrorMessage

protected java.lang.String sandTransmitErrorMessage

Text details of the transmission error.

sandTransmissionCount

protected int sandTransmissionCount

Counter to aid in tracking receipt of sent messages.

sandTransmitAuthID

protected long sandTransmitAuthID

The uniqueID of the authorized user of this message.

Constructor Detail

DataImportExport

public DataImportExport()

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 SandInstanceMessage

getSource

public java.lang.String getSource()

Accessor for source

setSource

public void setSource(java.lang.String source)

Mutator for source

setSource

public void setSource(java.lang.Object source)

Generic mutator for source

getSourceFlag

public static boolean getSourceFlag(int fieldflag)

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

getSourceLengthNorm

public static int getSourceLengthNorm()

Normal source length is 30 characters

getSourceLengthMax

public static int getSourceLengthMax()

Maximum source length is 70 characters

getSourceDefaultValue

public static java.lang.String getSourceDefaultValue()

Default value for source. Returns ""

getSourceInvalidValue

public static java.lang.String getSourceInvalidValue()

Invalid value for source. Returns null

getSourcePrintValue

public java.lang.String getSourcePrintValue()

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.

getSourceFieldPrintValue

public java.lang.String getSourceFieldPrintValue()

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

getSourceRange

public java.lang.String getSourceRange()

Return the range specification for this field

getSourceValidityCheck

public java.lang.String getSourceValidityCheck()

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.

getSourceMetatype

public java.lang.String getSourceMetatype()

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

getAction

public int getAction()

Accessor for action

setAction

public void setAction(int action)

Mutator for action

actionValueToLabel

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

actionLabelToValue

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

getActionPrintVals

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

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.

getActionKeyVals

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

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.

getActionActualVals

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

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

actionPrint2Key

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

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

actionPrint2Actual

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

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

actionActual2Print

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

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

getActionEnumSummary

public static java.lang.String getActionEnumSummary()

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

isActionExport

public boolean isActionExport()

boolean accessor for action value

isActionImport

public boolean isActionImport()

boolean accessor for action value

isActionRestore

public boolean isActionRestore()

boolean accessor for action value

getActionFlag

public static boolean getActionFlag(int fieldflag)

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

getActionDefaultValue

public static int getActionDefaultValue()

Default value for action. Returns ACTION_EXPORT

getActionInvalidValue

public static int getActionInvalidValue()

Invalid value for action. Returns Integer.MIN_VALUE

getActionPrintValue

public java.lang.String getActionPrintValue()

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.

getActionFieldPrintValue

public java.lang.String getActionFieldPrintValue()

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

getActionRange

public java.lang.String getActionRange()

Return the range specification for this field

getActionValidityCheck

public java.lang.String getActionValidityCheck()

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.

getActionMetatype

public java.lang.String getActionMetatype()

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

getDataDescriptions

public SandQueryMessage[] getDataDescriptions()

Accessor for dataDescriptions

setDataDescriptions

public void setDataDescriptions(SandQueryMessage[] dataDescriptions)

Mutator for dataDescriptions

setDataDescriptions

public void setDataDescriptions(java.lang.Object[] dataDescriptions)

Generic mutator for dataDescriptions

addDataDescriptions

public void addDataDescriptions(SandQueryMessage element)

Appends a value to dataDescriptions

addDataDescriptions

public void addDataDescriptions(SandQueryMessage[] elements)

Appends an array of values to dataDescriptions

getDataDescriptions

public SandQueryMessage getDataDescriptions(int index)

Returns the element at the specified index. Returns null/-1 if the index was out of bounds.

setDataDescriptions

public void setDataDescriptions(int index,
                                SandQueryMessage value)

Set the value at the index specified.

insertDataDescriptions

public void insertDataDescriptions(int index,
                                   SandQueryMessage 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.

removeDataDescriptions

public SandQueryMessage removeDataDescriptions(int index)

Remove the element at the specified index and return it.

removeDataDescriptionsValue

public boolean removeDataDescriptionsValue(SandQueryMessage value)

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

clearDataDescriptions

public void clearDataDescriptions()

Clears all values from dataDescriptions

dataDescriptionsContains

public boolean dataDescriptionsContains(SandQueryMessage val)

Returns true if dataDescriptions contains the specified value.

dataDescriptionsIndexOf

public int dataDescriptionsIndexOf(SandQueryMessage val)

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

sizeofDataDescriptions

public int sizeofDataDescriptions()

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

getDataDescriptionsFlag

public static boolean getDataDescriptionsFlag(int fieldflag)

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

getDataDescriptionsDefaultValue

public static SandQueryMessage[] getDataDescriptionsDefaultValue()

Default value for dataDescriptions. Returns new SandQueryMessage[0]