org.sandev.basics.sandmessages
Class CacheAction

java.lang.Object
  org.sandev.basics.structs.CacheActionStruct
      org.sandev.basics.sandmessages.CacheAction

All Implemented Interfaces:

Resolvable, SandInstanceMessage, SandMessage, SandStructMessage, SandTransmitMessage

public class CacheAction

extends CacheActionStruct

implements SandStructMessage, Resolvable, SandTransmitMessage

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

Field Summary

static int	ACTION_CHANGED The instance has been modified
static int	ACTION_DELETED The instance has been deleted
static int	ACTION_DUMPED For CacheManager processing reasons, this instance has been dumped from tracking.
static int	ACTION_REGISTER This source requests broadcast any updates of the specified instance.
static int	ACTION_UNDEFINED Invalid value
static int	ACTION_UNREGISTER This source no longer requires notification of changes to the specified instance.
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.CacheActionStruct

action, messageClass, revisionNumber, sources, uniqueID

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

CacheAction()
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	addSources(java.lang.String element) Appends a value to sources
void	addSources(java.lang.String[] elements) Appends an array of values to sources
void	clearSources() Clears all values from sources
CacheAction	cloneCacheAction() Make a deep copy of this CacheAction.
SandInstanceMessage	cloneMessage() Calls cloneCacheAction
SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(CacheAction 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.
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
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.
java.lang.String	getMessageClass() Accessor for messageClass
static java.lang.String	getMessageClassDefaultValue() Default value for messageClass.
java.lang.String	getMessageClassFieldPrintValue() Return the print name of the messageClass field.
static boolean	getMessageClassFlag(int fieldflag) Field flag accessor.
static java.lang.String	getMessageClassInvalidValue() Invalid value for messageClass.
static int	getMessageClassLengthMax() Maximum messageClass length is 255 characters
static int	getMessageClassLengthNorm() Normal messageClass length is 50 characters
java.lang.String	getMessageClassMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getMessageClassPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getMessageClassRange() Return the range specification for this field
java.lang.String	getMessageClassValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandQueryMessage	getQueryMessage() Returns null
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.
java.lang.String[]	getSources() Accessor for sources
java.lang.String	getSources(int index) Returns the element at the specified index.
static java.lang.String[]	getSourcesDefaultValue() Default value for sources.
static java.lang.String	getSourcesElementInvalidValue() Invalid value for sourceselement.
static boolean	getSourcesFlag(int fieldflag) Field flag accessor.
static java.lang.String[]	getSourcesInvalidValue() Invalid value for sources.
static int	getSourcesLengthMax() Maximum sources length is 70 characters
static int	getSourcesLengthNorm() Normal sources length is 30 characters
java.lang.String	getSourcesMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSourcesRange() Return the range specification for this field
java.lang.String	getSourcesValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandStructMessage	getStructMessage() Returns a new CacheAction instance
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.
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.
void	init() Initialize all fields to their default values
void	insertSources(int index, java.lang.String value) Insert the specified element at the specified index.
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.
java.lang.String	removeSources(int index) Remove the element at the specified index and return it.
boolean	removeSourcesValue(java.lang.String value) Removes the given element from sources.
void	setAction(int action) Mutator for action
void	setMessageClass(java.lang.Object messageClass) Generic mutator for messageClass
void	setMessageClass(java.lang.String messageClass) Mutator for messageClass
void	setRevisionNumber(long revisionNumber) Mutator for revisionNumber
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	setSources(int index, java.lang.String value) Set the value at the index specified.
void	setSources(java.lang.String[] sources) Mutator for sources
void	setUniqueID(long uniqueID) Mutator for uniqueID
int	sizeofSources() Returns the size of sources.
boolean	sourcesContains(java.lang.String val) Returns true if sources contains the specified value.
int	sourcesIndexOf(java.lang.String val) Return the index of the specified value in sources, or -1 if not found.
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_UNDEFINED

public static final int ACTION_UNDEFINED

Invalid value

See Also:

Constant Field Values

ACTION_CHANGED

public static final int ACTION_CHANGED

The instance has been modified

See Also:

Constant Field Values

ACTION_DELETED

public static final int ACTION_DELETED

The instance has been deleted

See Also:

Constant Field Values

ACTION_DUMPED

public static final int ACTION_DUMPED

For CacheManager processing reasons, this instance has been dumped from tracking. It must be registered again if tracking is still necessary.

See Also:

Constant Field Values

ACTION_REGISTER

public static final int ACTION_REGISTER

This source requests broadcast any updates of the specified instance.

See Also:

Constant Field Values

ACTION_UNREGISTER

public static final int ACTION_UNREGISTER

This source no longer requires notification of changes to the specified instance.

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

CacheAction

public CacheAction()

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

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.

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 0

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.

getUniqueID

public long getUniqueID()

Accessor for uniqueID

setUniqueID

public void setUniqueID(long uniqueID)

Mutator for uniqueID

getUniqueIDFlag

public static boolean getUniqueIDFlag(int fieldflag)

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

getUniqueIDDefaultValue

public static long getUniqueIDDefaultValue()

Default value for uniqueID. Returns 0

getUniqueIDInvalidValue

public static long getUniqueIDInvalidValue()

Invalid value for uniqueID. Returns Long.MIN_VALUE

getUniqueIDPrintValue

public java.lang.String getUniqueIDPrintValue()

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

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

getUniqueIDFieldPrintValue

public java.lang.String getUniqueIDFieldPrintValue()

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

getUniqueIDRange

public java.lang.String getUniqueIDRange()

Return the range specification for this field

getUniqueIDValidityCheck

public java.lang.String getUniqueIDValidityCheck()

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

getUniqueIDMetatype

public java.lang.String getUniqueIDMetatype()

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

getMessageClass

public java.lang.String getMessageClass()

Accessor for messageClass

setMessageClass

public void setMessageClass(java.lang.String messageClass)

Mutator for messageClass

setMessageClass

public void setMessageClass(java.lang.Object messageClass)

Generic mutator for messageClass

getMessageClassFlag

public static boolean getMessageClassFlag(int fieldflag)

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

getMessageClassLengthNorm

public static int getMessageClassLengthNorm()

Normal messageClass length is 50 characters

getMessageClassLengthMax

public static int getMessageClassLengthMax()

Maximum messageClass length is 255 characters

getMessageClassDefaultValue

public static java.lang.String getMessageClassDefaultValue()

Default value for messageClass. Returns ""

getMessageClassInvalidValue

public static java.lang.String getMessageClassInvalidValue()

Invalid value for messageClass. Returns null

getMessageClassPrintValue

public java.lang.String getMessageClassPrintValue()

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.

getMessageClassFieldPrintValue

public java.lang.String getMessageClassFieldPrintValue()

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

getMessageClassRange

public java.lang.String getMessageClassRange()

Return the range specification for this field

getMessageClassValidityCheck

public java.lang.String getMessageClassValidityCheck()

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.

getMessageClassMetatype

public java.lang.String getMessageClassMetatype()

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

getRevisionNumber

public long getRevisionNumber()

Accessor for revisionNumber

setRevisionNumber

public void setRevisionNumber(long revisionNumber)

Mutator for revisionNumber

getRevisionNumberFlag

public static boolean getRevisionNumberFlag(int fieldflag)

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

getRevisionNumberDefaultValue

public static long getRevisionNumberDefaultValue()

Default value for revisionNumber. Returns 0

getRevisionNumberInvalidValue

public static long getRevisionNumberInvalidValue()

Invalid value for revisionNumber. Returns Long.MIN_VALUE

getRevisionNumberPrintValue

public java.lang.String getRevisionNumberPrintValue()

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

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

getRevisionNumberFieldPrintValue

public java.lang.String getRevisionNumberFieldPrintValue()

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

getRevisionNumberRange

public java.lang.String getRevisionNumberRange()

Return the range specification for this field

getRevisionNumberValidityCheck

public java.lang.String getRevisionNumberValidityCheck()

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

getRevisionNumberMetatype

public java.lang.String getRevisionNumberMetatype()

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

getSources

public java.lang.String[] getSources()

Accessor for sources

setSources

public void setSources(java.lang.String[] sources)

Mutator for sources

addSources

public void addSources(java.lang.String element)

Appends a value to sources

addSources

public void addSources(java.lang.String[] elements)

Appends an array of values to sources

getSources

public java.lang.String getSources(int index)

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

setSources

public void setSources(int index,
                       java.lang.String value)

Set the value at the index specified.

insertSources

public void insertSources(int index,
                          java.lang.String 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.

removeSources

public java.lang.String removeSources(int index)

Remove the element at the specified index and return it.

removeSourcesValue

public boolean removeSourcesValue(java.lang.String value)

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

clearSources

public void clearSources()

Clears all values from sources

sourcesContains

public boolean sourcesContains(java.lang.String val)

Returns true if sources contains the specified value.

sourcesIndexOf

public int sourcesIndexOf(java.lang.String val)

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

sizeofSources

public int sizeofSources()

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

getSourcesFlag

public static boolean getSourcesFlag(int fieldflag)

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

getSourcesLengthNorm

public static int getSourcesLengthNorm()

Normal sources length is 30 characters

getSourcesLengthMax

public static int getSourcesLengthMax()

Maximum sources length is 70 characters

getSourcesDefaultValue

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

Default value for sources. Returns new String[0]

getSourcesElementInvalidValue

public static java.lang.String getSourcesElementInvalidValue()

Invalid value for sourceselement. Returns null

getSourcesInvalidValue

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

Invalid value for sources. Returns null

getSourcesRange

public java.lang.String getSourcesRange()

Return the range specification for this field

getSourcesValidityCheck

public java.lang.String getSourcesValidityCheck()

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.

getSourcesMetatype

public java.lang.String getSourcesMetatype()

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

getSandTransmitStatus

public int getSandTransmitStatus()

Accessor for sandTransmitStatus

Specified by:

getSandTransmitStatus in interface SandTransmitMessage

setSandTransmitStatus

public void setSandTransmitStatus(int sandTransmitStatus)

Mutator for sandTransmitStatus

Specified by:

setSandTransmitStatus in interface SandTransmitMessage

getSandTransmitStatusFlag

public static boolean getSandTransmitStatusFlag(int fieldflag)

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

getSandTransmitStatusDefaultValue

public static int getSandTransmitStatusDefaultValue()

Default value for sandTransmitStatus. Returns 0

getSandTransmitStatusInvalidValue

public static int getSandTransmitStatusInvalidValue()

Invalid value for sandTransmitStatus. Returns Integer.MIN_VALUE

getSandTransmitStatusPrintValue

public java.lang.String getSandTransmitStatusPrintValue()

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.

getSandTransmitStatusFieldPrintValue

public java.lang.String getSandTransmitStatusFieldPrintValue()

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

getSandTransmitStatusRange

public java.lang.String getSandTransmitStatusRange()

Return the range specification for this field

getSandTransmitStatusValidityCheck

public java.lang.String getSandTransmitStatusValidityCheck()

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.

getSandTransmitStatusMetatype

public java.lang.String getSandTransmitStatusMetatype()

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

getSandTransmitErrorMessage

public java.lang.String getSandTransmitErrorMessage()

Accessor for sandTransmitErrorMessage

Specified by:

getSandTransmitErrorMessage in interface SandTransmitMessage

setSandTransmitErrorMessage

public void setSandTransmitErrorMessage(java.lang.String sandTransmitErrorMessage)

Mutator for sandTransmitErrorMessage

Specified by:

setSandTransmitErrorMessage in interface SandTransmitMessage

setSandTransmitErrorMessage

public void setSandTransmitErrorMessage(java.lang.Object sandTransmitErrorMessage)

Generic mutator for sandTransmitErrorMessage

getSandTransmitErrorMessageFlag

public static boolean getSandTransmitErrorMessageFlag(int fieldflag)

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

getSandTransmitErrorMessageLengthNorm

public static int getSandTransmitErrorMessageLengthNorm()

Normal sandTransmitErrorMessage length is 30 characters

getSandTransmitErrorMessageLengthMax

public static int getSandTransmitErrorMessageLengthMax()

Maximum sandTransmitErrorMessage length is 70 characters

getSandTransmitErrorMessageDefaultValue

public static java.lang.String getSandTransmitErrorMessageDefaultValue()

Default value for sandTransmitErrorMessage. Returns ""

getSandTransmitErrorMessageInvalidValue

public static java.lang.String getSandTransmitErrorMessageInvalidValue()

Invalid value for sandTransmitErrorMessage. Returns null

getSandTransmitErrorMessagePrintValue

public java.lang.String getSandTransmitErrorMessagePrintValue()

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.

getSandTransmitErrorMessageFieldPrintValue

public java.lang.String getSandTransmitErrorMessageFieldPrintValue()

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

getSandTransmitErrorMessageRange

public java.lang.String getSandTransmitErrorMessageRange()

Return the range specification for this field

getSandTransmitErrorMessageValidityCheck

public java.lang.String getSandTransmitErrorMessageValidityCheck()

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.

getSandTransmitErrorMessageMetatype

public java.lang.String getSandTransmitErrorMessageMetatype()

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

getSandTransmissionCount

public int getSandTransmissionCount()

Accessor for sandTransmissionCount

Specified by:

getSandTransmissionCount in interface SandTransmitMessage

setSandTransmissionCount

public void setSandTransmissionCount(int sandTransmissionCount)

Mutator for sandTransmissionCount

Specified by:

setSandTransmissionCount in interface SandTransmitMessage

getSandTransmissionCountFlag

public static boolean getSandTransmissionCountFlag(int fieldflag)

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

getSandTransmissionCountDefaultValue

public static int getSandTransmissionCountDefaultValue()

Default value for sandTransmissionCount. Returns 0

getSandTransmissionCountInvalidValue

public static int getSandTransmissionCountInvalidValue()

Invalid value for sandTransmissionCount. Returns Integer.MIN_VALUE

getSandTransmissionCountPrintValue

public java.lang.String getSandTransmissionCountPrintValue()

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.

getSandTransmissionCountFieldPrintValue

public java.lang.String getSandTransmissionCountFieldPrintValue()

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

getSandTransmissionCountRange

public java.lang.String getSandTransmissionCountRange()

Return the range specification for this field

getSandTransmissionCountValidityCheck

public java.lang.String getSandTransmissionCountValidityCheck()

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.

getSandTransmissionCountMetatype

public java.lang.String getSandTransmissionCountMetatype()

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

getSandTransmitAuthID

public long getSandTransmitAuthID()

Accessor for sandTransmitAuthID

Specified by:

getSandTransmitAuthID in interface SandTransmitMessage

setSandTransmitAuthID

public void setSandTransmitAuthID(long sandTransmitAuthID)

Mutator for sandTransmitAuthID

Specified by:

setSandTransmitAuthID in interface SandTransmitMessage