org.sandev.ui.sandmessages
Class AggregateUpdateInstance

java.lang.Object
  org.sandev.ui.structs.VerbInstanceStruct
      org.sandev.ui.structs.AggregateUpdateInstanceStruct
          org.sandev.ui.sandmessages.AggregateUpdateInstance

All Implemented Interfaces:

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

public class AggregateUpdateInstance
extends AggregateUpdateInstanceStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable, VerbInstanceInterface

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.ui.structs.AggregateUpdateInstanceStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jun 15, 2007 11:40:44 PM

Field Summary

static int	SANDTRANSMITSTATUS_STATUS_APPERROR Possible value for sandTransmitStatus
static int	SANDTRANSMITSTATUS_STATUS_NORMAL Possible value for sandTransmitStatus
static int	SANDTRANSMITSTATUS_STATUS_SANDERROR Possible value for sandTransmitStatus
static int	SANDTRANSMITSTATUS_STATUS_SYSERROR Possible value for sandTransmitStatus

Fields inherited from class org.sandev.ui.structs.AggregateUpdateInstanceStruct

updates

Fields inherited from class org.sandev.ui.structs.VerbInstanceStruct

baseInstanceClass, sandTransmissionCount, sandTransmitAuthID, sandTransmitErrorMessage, sandTransmitStatus

Constructor Summary

AggregateUpdateInstance()
Default constructor calls init.

Method Summary

void	addUpdates(UpdateInstance element) Appends a value to updates
void	addUpdates(UpdateInstance[] elements) Appends an array of values to updates
void	clearUpdates() Clears all values from updates
AggregateUpdateInstance	cloneAggregateUpdateInstance() Make a deep copy of this AggregateUpdateInstance.
org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls cloneAggregateUpdateInstance
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(AggregateUpdateInstance other) Deep copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.SandInstanceMessage other) Copy the specified field from the given instance.
java.lang.String	debugDump(java.lang.String prefix) Dump this instance into a debug printable string.
void	defaultField(java.lang.String fieldname) Set the specified field to its default value.
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
boolean	fieldsValid() Validate the fields as specified in the SandInstanceMessage interface
org.sandev.basics.structs.SandAttrVal[]	fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
org.sandev.basics.structs.SandCollectionMessage	find(org.sandev.basics.structs.SandQueryMessage sqm) Return a matching collection of all directly contained instances matching the given query.
java.lang.Object	generalAccessor(java.lang.String fieldspec) General field accessor method.
org.sandev.basics.structs.SandAttrVal	generalDereference(java.lang.String fieldspec) General reference field accessor method.
void	generalModifier(int action, java.lang.String field, int index, java.lang.Object val) General mutator method.
java.lang.String[]	getAllFields() Return an array of all fields for this class.
java.lang.String	getBaseInstanceClass() Accessor for baseInstanceClass
static java.lang.String	getBaseInstanceClassDefaultValue() Default value for baseInstanceClass.
java.lang.String	getBaseInstanceClassFieldPrintValue() Return the print name of the baseInstanceClass field.
static boolean	getBaseInstanceClassFlag(int fieldflag) Field flag accessor.
static java.lang.String	getBaseInstanceClassInvalidValue() Invalid value for baseInstanceClass.
static int	getBaseInstanceClassLengthMax() Maximum baseInstanceClass length is 80 characters
static int	getBaseInstanceClassLengthNorm() Normal baseInstanceClass length is 40 characters
java.lang.String	getBaseInstanceClassMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getBaseInstanceClassPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getBaseInstanceClassRange() Return the range specification for this field
java.lang.String	getBaseInstanceClassValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.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(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Return the values for the summary fields, including dereference expressions.
org.sandev.basics.structs.SandPersistMessage	getInstance(java.lang.String classname, long id) If this instance directly contains the specified instance, then find it and return it.
org.sandev.basics.structs.SandInstanceMessage	getInstance(java.lang.String classname, java.lang.String fieldname, java.lang.String value) If this instance directly contains the specified instance, then find it and return it.
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.
org.sandev.basics.structs.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.
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 255 characters
static int	getSandTransmitErrorMessageLengthNorm() Normal sandTransmitErrorMessage length is 60 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 java.lang.String[]	getSandTransmitStatusActualVals() Return an array of the possible values for this field as Strings.
static int	getSandTransmitStatusDefaultValue() Default value for sandTransmitStatus.
static java.lang.String	getSandTransmitStatusEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
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.
static java.lang.String[]	getSandTransmitStatusKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getSandTransmitStatusMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getSandTransmitStatusPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getSandTransmitStatusPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSandTransmitStatusRange() Return the range specification for this field
java.lang.String	getSandTransmitStatusValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getShortName() Returns the unqualified name of this message.
org.sandev.basics.structs.SandStructMessage	getStructMessage() Returns a new AggregateUpdateInstance instance
org.sandev.basics.structs.SandUpdateMessage	getUpdateMessage() Returns a new AggregateUpdateInstanceUpdate instance
UpdateInstance[]	getUpdates() Accessor for updates.
UpdateInstance	getUpdates(int index) Returns the element at the specified index.
static UpdateInstance[]	getUpdatesDefaultValue() Default value for updates.
static UpdateInstance	getUpdatesElementInvalidValue() Invalid value for updateselement.
static boolean	getUpdatesFlag(int fieldflag) Field flag accessor.
static UpdateInstance[]	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	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, org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Returns the print representation of the value of the specified field, or the given default value if innaccessible.
void	init() Initialize all fields to their default values
void	insertUpdates(int index, UpdateInstance value) Insert the specified element at the specified index.
boolean	isEquivalent(org.sandev.basics.structs.SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, org.sandev.basics.util.IDLookup idlookup, org.sandev.basics.util.NameLookup namelookup, org.sandev.basics.util.AuthUser au) Validate the references as specified in the Resolvable interface.
UpdateInstance	removeUpdates(int index) Remove the element at the specified index and return it.
boolean	removeUpdatesValue(UpdateInstance value) Removes the given element from updates.
static java.lang.String	sandTransmitStatusActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	sandTransmitStatusLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	sandTransmitStatusLabelToValueStatic(java.lang.String label)
static java.lang.String	sandTransmitStatusPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	sandTransmitStatusPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	sandTransmitStatusValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	sandTransmitStatusValueToLabelStatic(int val)
void	setBaseInstanceClass(java.lang.Object baseInstanceClass) Generic mutator for baseInstanceClass
void	setBaseInstanceClass(java.lang.String baseInstanceClass) Mutator for baseInstanceClass
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	setUpdates(int index, UpdateInstance value) Set the value at the index specified.
void	setUpdates(java.lang.Object[] updates) Generic mutator for updates
void	setUpdates(UpdateInstance[] updates) Mutator for updates
int	sizeofUpdates() Returns the size of updates.
java.lang.String	toString() Return a string representation of this object.
boolean	updatesContains(UpdateInstance val) Returns true if updates contains the specified value.
int	updatesIndexOf(UpdateInstance 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_STATUS_NORMAL

public static final int SANDTRANSMITSTATUS_STATUS_NORMAL

Possible value for sandTransmitStatus

See Also:

Constant Field Values

SANDTRANSMITSTATUS_STATUS_SYSERROR

public static final int SANDTRANSMITSTATUS_STATUS_SYSERROR

Possible value for sandTransmitStatus

See Also:

Constant Field Values

SANDTRANSMITSTATUS_STATUS_SANDERROR

public static final int SANDTRANSMITSTATUS_STATUS_SANDERROR

Possible value for sandTransmitStatus

See Also:

Constant Field Values

SANDTRANSMITSTATUS_STATUS_APPERROR

public static final int SANDTRANSMITSTATUS_STATUS_APPERROR

Possible value for sandTransmitStatus

See Also:

Constant Field Values

Constructor Detail

AggregateUpdateInstance

public AggregateUpdateInstance()

Default constructor calls init.

Method Detail

getPrintname

public java.lang.String getPrintname()

Return the printname of the class

Specified by:

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

fieldHasFlag

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

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

Specified by:

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

getBaseInstanceClass

public java.lang.String getBaseInstanceClass()

Accessor for baseInstanceClass

Specified by:

getBaseInstanceClass in interface VerbInstanceInterface

setBaseInstanceClass

public void setBaseInstanceClass(java.lang.String baseInstanceClass)

Mutator for baseInstanceClass

Specified by:

setBaseInstanceClass in interface VerbInstanceInterface

setBaseInstanceClass

public void setBaseInstanceClass(java.lang.Object baseInstanceClass)

Generic mutator for baseInstanceClass

Specified by:

setBaseInstanceClass in interface VerbInstanceInterface

getBaseInstanceClassFlag

public static boolean getBaseInstanceClassFlag(int fieldflag)

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

getBaseInstanceClassLengthNorm

public static int getBaseInstanceClassLengthNorm()

Normal baseInstanceClass length is 40 characters

getBaseInstanceClassLengthMax

public static int getBaseInstanceClassLengthMax()

Maximum baseInstanceClass length is 80 characters

getBaseInstanceClassDefaultValue

public static java.lang.String getBaseInstanceClassDefaultValue()

Default value for baseInstanceClass. Returns ""

getBaseInstanceClassInvalidValue

public static java.lang.String getBaseInstanceClassInvalidValue()

Invalid value for baseInstanceClass. Returns null

getBaseInstanceClassPrintValue

public java.lang.String getBaseInstanceClassPrintValue()

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.

getBaseInstanceClassFieldPrintValue

public java.lang.String getBaseInstanceClassFieldPrintValue()

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

getBaseInstanceClassRange

public java.lang.String getBaseInstanceClassRange()

Return the range specification for this field

getBaseInstanceClassValidityCheck

public java.lang.String getBaseInstanceClassValidityCheck()

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.

getBaseInstanceClassMetatype

public java.lang.String getBaseInstanceClassMetatype()

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 VerbInstanceInterface

setSandTransmitStatus

public void setSandTransmitStatus(int sandTransmitStatus)

Mutator for sandTransmitStatus

Specified by:

setSandTransmitStatus in interface VerbInstanceInterface

sandTransmitStatusValueToLabel

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

sandTransmitStatusValueToLabelStatic

public static java.lang.String sandTransmitStatusValueToLabelStatic(int val)

sandTransmitStatusLabelToValue

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

sandTransmitStatusLabelToValueStatic

public static int sandTransmitStatusLabelToValueStatic(java.lang.String label)

getSandTransmitStatusPrintVals

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

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.

getSandTransmitStatusKeyVals

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

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.

getSandTransmitStatusActualVals

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

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

sandTransmitStatusPrint2Key

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

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

sandTransmitStatusPrint2Actual

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

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

sandTransmitStatusActual2Print

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

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

getSandTransmitStatusEnumSummary

public static java.lang.String getSandTransmitStatusEnumSummary()

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

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 -1

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 VerbInstanceInterface

setSandTransmitErrorMessage

public void setSandTransmitErrorMessage(java.lang.String sandTransmitErrorMessage)

Mutator for sandTransmitErrorMessage

Specified by:

setSandTransmitErrorMessage in interface VerbInstanceInterface

setSandTransmitErrorMessage

public void setSandTransmitErrorMessage(java.lang.Object sandTransmitErrorMessage)

Generic mutator for sandTransmitErrorMessage

Specified by:

setSandTransmitErrorMessage in interface VerbInstanceInterface

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 60 characters

getSandTransmitErrorMessageLengthMax

public static int getSandTransmitErrorMessageLengthMax()

Maximum sandTransmitErrorMessage length is 255 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.

getSandTransmitAuthID

public long getSandTransmitAuthID()

Accessor for sandTransmitAuthID

Specified by:

getSandTransmitAuthID in interface VerbInstanceInterface

setSandTransmitAuthID

public void setSandTransmitAuthID(long sandTransmitAuthID)

Mutator for sandTransmitAuthID

Specified by:

setSandTransmitAuthID in interface VerbInstanceInterface

getSandTransmitAuthIDFlag

public static boolean getSandTransmitAuthIDFlag(int fieldflag)

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

getSandTransmitAuthIDDefaultValue

public static long getSandTransmitAuthIDDefaultValue()

Default value for sandTransmitAuthID. Returns 0

getSandTransmitAuthIDInvalidValue

public static long getSandTransmitAuthIDInvalidValue()

Invalid value for sandTransmitAuthID. Returns Long.MIN_VALUE

getSandTransmitAuthIDPrintValue

public java.lang.String getSandTransmitAuthIDPrintValue()

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.

getSandTransmitAuthIDFieldPrintValue

public java.lang.String getSandTransmitAuthIDFieldPrintValue()

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

getSandTransmitAuthIDRange

public java.lang.String getSandTransmitAuthIDRange()

Return the range specification for this field

getSandTransmitAuthIDValidityCheck

public java.lang.String getSandTransmitAuthIDValidityCheck()

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.

getSandTransmitAuthIDMetatype

public java.lang.String getSandTransmitAuthIDMetatype()

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 VerbInstanceInterface

setSandTransmissionCount

public void setSandTransmissionCount(int sandTransmissionCount)

Mutator for sandTransmissionCount

Specified by:

setSandTransmissionCount in interface VerbInstanceInterface

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.

getUpdates

public UpdateInstance[] 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(UpdateInstance[] updates)

Mutator for updates

setUpdates

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

Generic mutator for updates

addUpdates

public void addUpdates(UpdateInstance element)

Appends a value to updates

addUpdates

public void addUpdates(UpdateInstance[] elements)

Appends an array of values to updates

getUpdates

public UpdateInstance 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,
                       UpdateInstance value)

Set the value at the index specified.

insertUpdates

public void insertUpdates(int index,
                          UpdateInstance 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 UpdateInstance removeUpdates(int index)

Remove the element at the specified index and return it.

removeUpdatesValue

public boolean removeUpdatesValue(UpdateInstance 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(UpdateInstance val)

Returns true if updates contains the specified value.

updatesIndexOf

public int updatesIndexOf(UpdateInstance 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 UpdateInstance[] getUpdatesDefaultValue()

Default value for updates. Returns new UpdateInstance[0]

getUpdatesElementInvalidValue

public static UpdateInstance getUpdatesElementInvalidValue()

Invalid value for updateselement. Returns null

getUpdatesInvalidValue

public static UpdateInstance[] getUpdatesInvalidValue()

Invalid value for updates. Returns null

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.

init

public void init()

Initialize all fields to their default values

getShortName

public java.lang.String getShortName()

Returns the unqualified name of this message.

Specified by:

getShortName in interface org.sandev.basics.structs.SandMessage

getQueryMessage

public org.sandev.basics.structs.SandQueryMessage getQueryMessage()

Returns null

Specified by:

getQueryMessage in interface org.sandev.basics.structs.SandMessage

getCollectionMessage

public org.sandev.basics.structs.SandCollectionMessage getCollectionMessage()

Returns null

Specified by:

getCollectionMessage in interface org.sandev.basics.structs.SandMessage

getUpdateMessage

public org.sandev.basics.structs.SandUpdateMessage getUpdateMessage()

Returns a new AggregateUpdateInstanceUpdate instance

Specified by:

getUpdateMessage in interface org.sandev.basics.structs.SandMessage

getStructMessage

public org.sandev.basics.structs.SandStructMessage getStructMessage()

Returns a new AggregateUpdateInstance instance

Specified by:

getStructMessage in interface org.sandev.basics.structs.SandMessage

isEquivalent

public boolean isEquivalent(org.sandev.basics.structs.SandMessage sm)

Declared field equivalence check as specified by the SandMessage interface. String values are trimmed before comparison because conversions may occasionally result in trailing whitespace, which should not cause equivalence comparisons to fail. Comparisons are case insensitive since that corresponds to what most people expect, and how most databases work.

When comparing arrays, it is possible that the array elements may have been set to null as part of authorization filtering or similar unusual circumstances. A null array element is only equivalent to another null array element.

Specified by:

isEquivalent in interface org.sandev.basics.structs.SandMessage

generalModifier

public void generalModifier(int action,
                            java.lang.String field,
                            int index,
                            java.lang.Object val)
                     throws org.sandev.basics.structs.SandException

General mutator method. Specified by SandInstanceMessage interface.

Specified by:

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

Throws:

org.sandev.basics.structs.SandException

generalDereference

public org.sandev.basics.structs.SandAttrVal generalDereference(java.lang.String fieldspec)

General reference field accessor method. Specified by SandInstanceMessage interface.

Specified by:

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

generalAccessor

public java.lang.Object generalAccessor(java.lang.String fieldspec)

General field accessor method. Specified by SandInstanceMessage interface.

Specified by:

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

getDisplayFields

public java.lang.String[] getDisplayFields()

Return an array of the summary field names for this class.

Specified by:

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

getDisplayFieldsPrint

public java.lang.String[] getDisplayFieldsPrint()

Return an array of the summary field print names for this class.

Specified by:

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

getDisplayValues

public java.lang.String[] getDisplayValues()

Return the values for the summary fields. The standard String representation of each value is returned. For Dates, the default DateFormat output is used. For enums, the print value is used. These can be further transformed as needed.

Specified by:

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

getDisplayValues

public java.lang.String[] getDisplayValues(org.sandev.basics.util.IDLookup lookup,
                                           org.sandev.basics.util.AuthUser user,
                                           java.lang.String defaultVal)

Return the values for the summary fields, including dereference expressions.

Specified by:

getDisplayValues in interface org.sandev.basics.util.Resolvable

getValueForFieldName

public java.lang.String getValueForFieldName(java.lang.String fieldname,
                                             org.sandev.basics.util.IDLookup lookup,
                                             org.sandev.basics.util.AuthUser user,
                                             java.lang.String defaultVal)

Returns the print representation of the value of the specified field, or the given default value if innaccessible. A field value may be innaccessible due to authorization, null reference, or other call failure.

Specified by:

getValueForFieldName in interface VerbInstanceInterface

getAllFields

public java.lang.String[] getAllFields()

Return an array of all fields for this class.

Specified by:

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

getContainedMessageFields

public java.lang.String[] getContainedMessageFields()

Return an array of all contained message fields.

Specified by:

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

defaultField

public void defaultField(java.lang.String fieldname)

Set the specified field to its default value.

Specified by:

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

getPrintnameForField

public java.lang.String getPrintnameForField(java.lang.String fieldname)

Given a fieldname, return its declared printname if declared. If no printname was declared then this returns the field name.

Specified by:

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

cloneMessage

public org.sandev.basics.structs.SandInstanceMessage cloneMessage()

Calls cloneAggregateUpdateInstance

Specified by:

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

cloneAggregateUpdateInstance

public AggregateUpdateInstance cloneAggregateUpdateInstance()

Make a deep copy of this AggregateUpdateInstance. Creates a new instance and then calls copyDataFrom.

copyDataFrom

public void copyDataFrom(AggregateUpdateInstance other)

Deep copy all the data from the specified instance. If the other instance is null then this method does nothing.

copyFieldValue

public void copyFieldValue(java.lang.String fieldName,
                           org.sandev.basics.structs.SandInstanceMessage other)

Copy the specified field from the given instance.

Specified by:

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

fieldValidate

public org.sandev.basics.structs.SandAttrVal[] fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields)

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

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

fieldsValid

public boolean fieldsValid()

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

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

referenceValidate

public java.lang.String[] referenceValidate(java.lang.String[] locations,
                                            java.lang.String prefix,
                                            org.sandev.basics.util.IDLookup idlookup,
                                            org.sandev.basics.util.NameLookup namelookup,
                                            org.sandev.basics.util.AuthUser au)
                                     throws org.sandev.basics.structs.SandException

Validate the references as specified in the Resolvable interface.

Specified by:

referenceValidate in interface org.sandev.basics.util.Resolvable

Throws:

org.sandev.basics.structs.SandException

convertToSuperstructClass

public org.sandev.basics.structs.SandInstanceMessage convertToSuperstructClass()

Return a new instance of the message associated with the superstruct of this instance. Return null if the source struct for this message does not extend another struct.

Specified by:

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

debugDump

public java.lang.String debugDump(java.lang.String prefix)

Dump this instance into a debug printable string.

Specified by:

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

getDisplayID

public java.lang.String getDisplayID()

Return the displayID for this message instance

Specified by:

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

getInstance

public org.sandev.basics.structs.SandPersistMessage getInstance(java.lang.String classname,
                                                                long id)

If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

Specified by:

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

getInstance

public org.sandev.basics.structs.SandInstanceMessage getInstance(java.lang.String classname,
                                                                 java.lang.String fieldname,
                                                                 java.lang.String value)

If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

Specified by:

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

find

public org.sandev.basics.structs.SandCollectionMessage find(org.sandev.basics.structs.SandQueryMessage sqm)

Return a matching collection of all directly contained instances matching the given query.

Specified by:

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

toString

public java.lang.String toString()

Return a string representation of this object. Uses the declared summary fields minus any dereference expressions.

Overrides:

toString in class java.lang.Object