org.sandev.basics.sandmessages
Class AggregateUpdate

java.lang.Object
  org.sandev.basics.structs.AggregateUpdateStruct
      org.sandev.basics.sandmessages.AggregateUpdate

All Implemented Interfaces:

SandInstanceMessage, SandMessage, SandStructMessage, SandTransmitMessage, InfoReport, Resolvable

public class AggregateUpdate
extends AggregateUpdateStruct
implements SandStructMessage, Resolvable, SandTransmitMessage, InfoReport

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.structs.AggregateUpdateStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jul 31, 2008 4:34:14 PM

Field Summary

protected int	sandTransmissionCount Counter to aid in tracking receipt of sent messages.
protected java.util.Locale	sandTransmissionLocale The Locale in effect for the current transmission.
protected long	sandTransmitAuthID The uniqueID of the authorized user of this message.
protected java.lang.String	sandTransmitErrorCode Optional code associated with the transmission error.
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.AggregateUpdateStruct

notices, updates

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

FIELDCHECK_EMPTYSTRINGPRINTVAL, 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_SUMMARYEDIT, 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

AggregateUpdate()
Default constructor calls init.

Method Summary

void	addNotices(ErrorInfo element) Appends a value to notices
void	addNotices(ErrorInfo[] elements) Appends an array of values to notices
void	addOutput(int sev, java.lang.String fieldname, java.lang.String code, java.lang.String text) Convenience append method to add output text.
void	addUpdates(SandUpdateMessage element) Appends a value to updates
void	addUpdates(SandUpdateMessage[] elements) Appends an array of values to updates
void	appendInfo(java.lang.String text) Convenience append method for informational messages
void	appendInfo(java.lang.String field, java.lang.String code, java.lang.String text) Convenience append method for informational messages
void	clearNotices() Clears all values from notices
void	clearUpdates() Clears all values from updates
AggregateUpdate	cloneAggregateUpdate() Make a deep copy of this AggregateUpdate.
SandInstanceMessage	cloneMessage() Calls cloneAggregateUpdate
SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(AggregateUpdate other, boolean deepcopy) 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
SandCollectionMessage	find(SandQueryMessage sqm) Return a matching collection of all directly contained instances matching the given query.
SandStructMessage	findUpdatedInstance(long uniqueID) Find the latest updated instance of the given uniqueID and return it, or null if not found.
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.
java.lang.String[]	getAllFields() Return an array of all fields for this class.
int	getBaseMemoryUse() Return the base memory use for this object.
SandCollectionMessage	getCollectionMessage() Returns null
java.lang.String[]	getContainedMessageFields() Return an array of all contained message fields.
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(IDLookup lookup, AuthUser user, java.lang.String defaultVal) Return the values for the summary fields, including dereference expressions.
SandPersistMessage	getInstance(java.lang.String classname, long id) If this instance directly contains the specified instance, then find it and return it.
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.
java.lang.String	getLayoutXML() Return the fieldlayout XML or null if not defined.
long	getNextTempID() Return a new temporary uniqueID value for use in creation of a new instance.
long	getNextTempID(java.util.List updMsgs) Works just like the no args version of the method, but also traverses all updates in the given list.
ErrorInfo[]	getNotices() Accessor for notices.
ErrorInfo	getNotices(int index) Returns the element at the specified index.
static ErrorInfo[]	getNoticesDefaultValue() Default value for notices.
static ErrorInfo	getNoticesElementInvalidValue() Invalid value for noticeselement.
java.lang.String	getNoticesFieldPrintValue() Return the print name of the notices field.
static boolean	getNoticesFlag(int fieldflag) Field flag accessor.
static ErrorInfo[]	getNoticesInvalidValue() Invalid value for notices.
java.lang.String	getNoticesMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getNoticesPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getNoticesRange() Return the range specification for this field
java.lang.String	getNoticesValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
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.
SandQueryMessage	getQueryMessage() Returns null
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.
java.util.Locale	getSandTransmissionLocale() Accessor for sandTransmissionLocale
static java.util.Locale	getSandTransmissionLocaleDefaultValue() Default value for sandTransmissionLocale.
java.lang.String	getSandTransmissionLocaleFieldPrintValue() Return the print name of the sandTransmissionLocale field.
static boolean	getSandTransmissionLocaleFlag(int fieldflag) Field flag accessor.
static java.util.Locale	getSandTransmissionLocaleInvalidValue() Invalid value for sandTransmissionLocale.
java.lang.String	getSandTransmissionLocaleMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSandTransmissionLocalePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSandTransmissionLocaleRange() Return the range specification for this field
java.lang.String	getSandTransmissionLocaleValidityCheck() 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	getSandTransmitErrorCode() Accessor for sandTransmitErrorCode
static java.lang.String	getSandTransmitErrorCodeDefaultValue() Default value for sandTransmitErrorCode.
java.lang.String	getSandTransmitErrorCodeFieldPrintValue() Return the print name of the sandTransmitErrorCode field.
static boolean	getSandTransmitErrorCodeFlag(int fieldflag) Field flag accessor.
static java.lang.String	getSandTransmitErrorCodeInvalidValue() Invalid value for sandTransmitErrorCode.
static int	getSandTransmitErrorCodeLengthMax() Maximum sandTransmitErrorCode length is 70 characters
static int	getSandTransmitErrorCodeLengthNorm() Normal sandTransmitErrorCode length is 30 characters
java.lang.String	getSandTransmitErrorCodeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSandTransmitErrorCodePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSandTransmitErrorCodeRange() Return the range specification for this field
java.lang.String	getSandTransmitErrorCodeValidityCheck() 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.
SandStructMessage	getStructMessage() Returns a new AggregateUpdate instance
SandUpdateMessage	getUpdateMessage() Returns null
SandUpdateMessage[]	getUpdates() Accessor for updates.
SandUpdateMessage	getUpdates(int index) Returns the element at the specified index.
static SandUpdateMessage[]	getUpdatesDefaultValue() Default value for updates.
static SandUpdateMessage	getUpdatesElementInvalidValue() Invalid value for updateselement.
java.lang.String	getUpdatesFieldPrintValue() Return the print name of the updates field.
static boolean	getUpdatesFlag(int fieldflag) Field flag accessor.
static SandUpdateMessage[]	getUpdatesInvalidValue() Invalid value for updates.
java.lang.String	getUpdatesMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getUpdatesPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getUpdatesRange() Return the range specification for this field
java.lang.String	getUpdatesValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
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	hasDeletes() Return true if this AggregateUpdate contains DELETE updates.
void	init() Initialize all fields to their default values
void	insertNotices(int index, ErrorInfo value) Insert the specified element at the specified index.
void	insertUpdates(int index, SandUpdateMessage value) Insert the specified element at the specified index.
boolean	isEquivalent(SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
boolean	noticesContains(ErrorInfo val) Returns true if notices contains the specified value.
int	noticesIndexOf(ErrorInfo val) Return the index of the specified value in notices, or -1 if not found.
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.
ErrorInfo	removeNotices(int index) Remove the element at the specified index and return it.
boolean	removeNoticesValue(ErrorInfo value) Removes the given element from notices.
SandUpdateMessage	removeUpdates(int index) Remove the element at the specified index and return it.
boolean	removeUpdatesValue(SandUpdateMessage value) Removes the given element from updates.
void	setNotices(ErrorInfo[] notices) Mutator for notices
void	setNotices(int index, ErrorInfo value) Set the value at the index specified.
void	setNotices(java.lang.Object[] notices) Generic mutator for notices
void	setSandTransmissionCount(int sandTransmissionCount) Mutator for sandTransmissionCount
void	setSandTransmissionLocale(java.util.Locale sandTransmissionLocale) Mutator for sandTransmissionLocale
void	setSandTransmissionLocale(java.lang.Object sandTransmissionLocale) Generic mutator for sandTransmissionLocale
void	setSandTransmitAuthID(long sandTransmitAuthID) Mutator for sandTransmitAuthID
void	setSandTransmitError(java.lang.String code, java.lang.String errText) Sets both the code and the error in a single method.
void	setSandTransmitErrorCode(java.lang.Object sandTransmitErrorCode) Generic mutator for sandTransmitErrorCode
void	setSandTransmitErrorCode(java.lang.String sandTransmitErrorCode) Mutator for sandTransmitErrorCode
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	setUpdates(int index, SandUpdateMessage value) Set the value at the index specified.
void	setUpdates(java.lang.Object[] updates) Generic mutator for updates
void	setUpdates(SandUpdateMessage[] updates) Mutator for updates
AggregateUpdate	shallowCopy() Make a shallow copy of this AggregateUpdate.
int	sizeofNotices() Returns the size of notices.
int	sizeofUpdates() Returns the size of updates.
java.lang.String	toString() Return a string representation of this object.
boolean	updatesContains(SandUpdateMessage val) Returns true if updates contains the specified value.
int	updatesIndexOf(SandUpdateMessage val) Return the index of the specified value in updates, or -1 if not found.

Methods inherited from class java.lang.Object

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

Field Detail

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.

sandTransmitErrorCode

protected java.lang.String sandTransmitErrorCode

Optional code associated with the transmission error.

sandTransmissionCount

protected int sandTransmissionCount

Counter to aid in tracking receipt of sent messages.

sandTransmissionLocale

protected java.util.Locale sandTransmissionLocale

The Locale in effect for the current transmission.

sandTransmitAuthID

protected long sandTransmitAuthID

The uniqueID of the authorized user of this message.

Constructor Detail

AggregateUpdate

public AggregateUpdate()

Default constructor calls init.

Method Detail

getPrintname

public java.lang.String getPrintname()

Return the printname of the class

Specified by:

getPrintname in interface 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 SandInstanceMessage

getUpdates

public SandUpdateMessage[] getUpdates()

Accessor for updates. The returned value may or may not be the actual data member. Always write back a changed array using setUpdates.

setUpdates

public void setUpdates(SandUpdateMessage[] updates)

Mutator for updates

setUpdates

public void setUpdates(java.lang.Object[] updates)

Generic mutator for updates

addUpdates

public void addUpdates(SandUpdateMessage element)

Appends a value to updates

addUpdates

public void addUpdates(SandUpdateMessage[] elements)

Appends an array of values to updates

getUpdates

public SandUpdateMessage getUpdates(int index)

Returns the element at the specified index. Returns null if updates is null or smaller than index.

setUpdates

public void setUpdates(int index,
                       SandUpdateMessage value)

Set the value at the index specified.

insertUpdates

public void insertUpdates(int index,
                          SandUpdateMessage 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.

removeUpdates

public SandUpdateMessage removeUpdates(int index)

Remove the element at the specified index and return it.

removeUpdatesValue

public boolean removeUpdatesValue(SandUpdateMessage value)

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

clearUpdates

public void clearUpdates()

Clears all values from updates

updatesContains

public boolean updatesContains(SandUpdateMessage val)

Returns true if updates contains the specified value.

updatesIndexOf

public int updatesIndexOf(SandUpdateMessage val)

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

sizeofUpdates

public int sizeofUpdates()

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

getUpdatesFlag

public static boolean getUpdatesFlag(int fieldflag)

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

getUpdatesDefaultValue

public static SandUpdateMessage[] getUpdatesDefaultValue()

Default value for updates. Returns new SandUpdateMessage[0]

getUpdatesElementInvalidValue

public static SandUpdateMessage getUpdatesElementInvalidValue()

Invalid value for updateselement. Returns null

getUpdatesInvalidValue

public static SandUpdateMessage[] getUpdatesInvalidValue()

Invalid value for updates. Returns null

getUpdatesPrintValue

public java.lang.String getUpdatesPrintValue()

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.

getUpdatesFieldPrintValue

public java.lang.String getUpdatesFieldPrintValue()

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

getUpdatesRange

public java.lang.String getUpdatesRange()

Return the range specification for this field

getUpdatesValidityCheck

public java.lang.String getUpdatesValidityCheck()

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.

getUpdatesMetatype

public java.lang.String getUpdatesMetatype()

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

getNotices

public ErrorInfo[] getNotices()

Accessor for notices. The returned value may or may not be the actual data member. Always write back a changed array using setNotices.

setNotices

public void setNotices(ErrorInfo[] notices)

Mutator for notices

setNotices

public void setNotices(java.lang.Object[] notices)

Generic mutator for notices

addNotices

public void addNotices(ErrorInfo element)

Appends a value to notices

addNotices

public void addNotices(ErrorInfo[] elements)

Appends an array of values to notices

getNotices

public ErrorInfo getNotices(int index)

Returns the element at the specified index. Returns null if notices is null or smaller than index.

setNotices

public void setNotices(int index,
                       ErrorInfo value)

Set the value at the index specified.

insertNotices

public void insertNotices(int index,
                          ErrorInfo 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.

removeNotices

public ErrorInfo removeNotices(int index)

Remove the element at the specified index and return it.

removeNoticesValue

public boolean removeNoticesValue(ErrorInfo value)

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

clearNotices

public void clearNotices()

Clears all values from notices

noticesContains

public boolean noticesContains(ErrorInfo val)

Returns true if notices contains the specified value.

noticesIndexOf

public int noticesIndexOf(ErrorInfo val)

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

sizeofNotices

public int sizeofNotices()

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

getNoticesFlag

public static boolean getNoticesFlag(int fieldflag)

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

getNoticesDefaultValue

public static ErrorInfo[] getNoticesDefaultValue()

Default value for notices. Returns new ErrorInfo[0]

getNoticesElementInvalidValue

public static ErrorInfo getNoticesElementInvalidValue()

Invalid value for noticeselement. Returns null

getNoticesInvalidValue

public static ErrorInfo[] getNoticesInvalidValue()

Invalid value for notices. Returns null

getNoticesPrintValue

public java.lang.String getNoticesPrintValue()

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.

getNoticesFieldPrintValue

public java.lang.String getNoticesFieldPrintValue()

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

getNoticesRange

public java.lang.String getNoticesRange()

Return the range specification for this field

getNoticesValidityCheck

public java.lang.String getNoticesValidityCheck()

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.

getNoticesMetatype

public java.lang.String getNoticesMetatype()

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.

getSandTransmitErrorCode

public java.lang.String getSandTransmitErrorCode()

Accessor for sandTransmitErrorCode

Specified by:

getSandTransmitErrorCode in interface SandTransmitMessage

setSandTransmitErrorCode

public void setSandTransmitErrorCode(java.lang.String sandTransmitErrorCode)

Mutator for sandTransmitErrorCode

Specified by:

setSandTransmitErrorCode in interface SandTransmitMessage

setSandTransmitErrorCode

public void setSandTransmitErrorCode(java.lang.Object sandTransmitErrorCode)

Generic mutator for sandTransmitErrorCode

setSandTransmitError

public void setSandTransmitError(java.lang.String code,
                                 java.lang.String errText)

Sets both the code and the error in a single method.

Specified by:

setSandTransmitError in interface SandTransmitMessage

getSandTransmitErrorCodeFlag

public static boolean getSandTransmitErrorCodeFlag(int fieldflag)

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

getSandTransmitErrorCodeLengthNorm

public static int getSandTransmitErrorCodeLengthNorm()

Normal sandTransmitErrorCode length is 30 characters

getSandTransmitErrorCodeLengthMax

public static int getSandTransmitErrorCodeLengthMax()

Maximum sandTransmitErrorCode length is 70 characters

getSandTransmitErrorCodeDefaultValue

public static java.lang.String getSandTransmitErrorCodeDefaultValue()

Default value for sandTransmitErrorCode. Returns ""

getSandTransmitErrorCodeInvalidValue

public static java.lang.String getSandTransmitErrorCodeInvalidValue()

Invalid value for sandTransmitErrorCode. Returns null

getSandTransmitErrorCodePrintValue

public java.lang.String getSandTransmitErrorCodePrintValue()

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.

getSandTransmitErrorCodeFieldPrintValue

public java.lang.String getSandTransmitErrorCodeFieldPrintValue()

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

getSandTransmitErrorCodeRange

public java.lang.String getSandTransmitErro