Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.sandev.ui.sandmessages
Class UpdateInstance

java.lang.Object
  extended by org.sandev.ui.structs.VerbInstanceStruct
      extended by org.sandev.ui.structs.UpdateInstanceStruct
          extended by org.sandev.ui.sandmessages.UpdateInstance
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 UpdateInstance
extends UpdateInstanceStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable, VerbInstanceInterface

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

Field Summary
static int ACTION_ACTION_ADD
          Possible value for action
static int ACTION_ACTION_DELETE
          Possible value for action
static int ACTION_ACTION_UPDATE
          Possible value for action
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.UpdateInstanceStruct
action, instance, source
 
Fields inherited from class org.sandev.ui.structs.VerbInstanceStruct
baseInstanceClass, sandTransmissionCount, sandTransmitAuthID, sandTransmitErrorMessage, sandTransmitStatus
 
Constructor Summary
UpdateInstance()
          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 int actionLabelToValueStatic(java.lang.String label)
           
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.
static java.lang.String actionValueToLabelStatic(int val)
           
 org.sandev.basics.structs.SandInstanceMessage cloneMessage()
          Calls cloneUpdateInstance
 UpdateInstance cloneUpdateInstance()
          Make a deep copy of this UpdateInstance.
 org.sandev.basics.structs.SandInstanceMessage convertToSuperstructClass()
          Return a new instance of the message associated with the superstruct of this instance.
 void copyDataFrom(UpdateInstance other, boolean deepcopy)
          Copy all the data from the specified instance.
 void copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.SandInstanceMessage other)
          Copy the specified field from the given instance.
 java.lang.String debugDump(java.lang.String prefix)
          Dump this instance into a debug printable string.
 void defaultField(java.lang.String fieldname)
          Set the specified field to its default value.
 boolean fieldHasFlag(java.lang.String fieldname, int fieldflag)
          Return true if the named field declares the indicated flag, false otherwise.
 boolean fieldsValid()
          Validate the fields as specified in the SandInstanceMessage interface
 org.sandev.basics.structs.SandAttrVal[] fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields)
          Validate the fields as specified in the SandInstanceMessage interface
 org.sandev.basics.structs.SandCollectionMessage find(org.sandev.basics.structs.SandQueryMessage sqm)
          Return a matching collection of all directly contained instances matching the given query.
 java.lang.Object generalAccessor(java.lang.String fieldspec)
          General field accessor method.
 org.sandev.basics.structs.SandAttrVal generalDereference(java.lang.String fieldspec)
          General reference field accessor method.
 void generalModifier(int action, java.lang.String field, int index, java.lang.Object val)
          General mutator method.
 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.
 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.
 int getBaseMemoryUse()
          Return the base memory use for this object.
 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.SandStructMessage getInstance()
          Accessor for instance
 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.
static org.sandev.basics.structs.SandStructMessage getInstanceDefaultValue()
          Default value for instance.
 java.lang.String getInstanceFieldPrintValue()
          Return the print name of the instance field.
static boolean getInstanceFlag(int fieldflag)
          Field flag accessor.
static org.sandev.basics.structs.SandStructMessage getInstanceInvalidValue()
          Invalid value for instance.
 java.lang.String getInstanceMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getInstancePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getInstanceRange()
          Return the range specification for this field
 java.lang.String getInstanceValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getLayoutXML()
          Return the fieldlayout XML or null if not defined.
 java.lang.String getPrintname()
          Return the printname of the class
 java.lang.String getPrintnameForField(java.lang.String fieldname)
          Given a fieldname, return its declared printname if declared.
 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.
 java.lang.String getSource()
          Accessor for source
static java.lang.String getSourceDefaultValue()
          Default value for source.
 java.lang.String getSourceFieldPrintValue()
          Return the print name of the source field.
static boolean getSourceFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getSourceInvalidValue()
          Invalid value for source.
static int getSourceLengthMax()
          Maximum source length is 80 characters
static int getSourceLengthNorm()
          Normal source length is 40 characters
 java.lang.String getSourceMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getSourcePrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getSourceRange()
          Return the range specification for this field
 java.lang.String getSourceValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 org.sandev.basics.structs.SandStructMessage getStructMessage()
          Returns a new UpdateInstance instance
 org.sandev.basics.structs.SandUpdateMessage getUpdateMessage()
          Returns a new UpdateInstanceUpdate instance
 java.lang.String getValueForFieldName(java.lang.String fieldname, org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal)
          Returns the print representation of the value of the specified field, or the given default value if innaccessible.
 void init()
          Initialize all fields to their default values
 boolean isEquivalent(org.sandev.basics.structs.SandMessage sm)
          Declared field equivalence check as specified by the SandMessage interface.
 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.
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 setAction(int action)
          Mutator for action
 void setBaseInstanceClass(java.lang.Object baseInstanceClass)
          Generic mutator for baseInstanceClass
 void setBaseInstanceClass(java.lang.String baseInstanceClass)
          Mutator for baseInstanceClass
 void setInstance(java.lang.Object instance)
          Generic mutator for instance
 void setInstance(org.sandev.basics.structs.SandStructMessage instance)
          Mutator for instance
 void setSandTransmissionCount(int sandTransmissionCount)
          Mutator for sandTransmissionCount
 void setSandTransmitAuthID(long sandTransmitAuthID)
          Mutator for sandTransmitAuthID
 void setSandTransmitErrorMessage(java.lang.Object sandTransmitErrorMessage)
          Generic mutator for sandTransmitErrorMessage
 void setSandTransmitErrorMessage(java.lang.String sandTransmitErrorMessage)
          Mutator for sandTransmitErrorMessage
 void setSandTransmitStatus(int sandTransmitStatus)
          Mutator for sandTransmitStatus
 void setSource(java.lang.Object source)
          Generic mutator for source
 void setSource(java.lang.String source)
          Mutator for source
 UpdateInstance shallowCopy()
          Make a shallow copy of this UpdateInstance.
 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

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

ACTION_ACTION_ADD

public static final int ACTION_ACTION_ADD
Possible value for action

See Also:
Constant Field Values

ACTION_ACTION_UPDATE

public static final int ACTION_ACTION_UPDATE
Possible value for action

See Also:
Constant Field Values

ACTION_ACTION_DELETE

public static final int ACTION_ACTION_DELETE
Possible value for action

See Also:
Constant Field Values
Constructor Detail

UpdateInstance

public UpdateInstance()
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.

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.

actionValueToLabelStatic

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

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.

actionLabelToValueStatic

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

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 ACTION_ACTION_ADD

getActionInvalidValue

public static int getActionInvalidValue()
Invalid value for action. Returns -1

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.

getInstance

public org.sandev.basics.structs.SandStructMessage getInstance()
Accessor for instance

setInstance

public void setInstance(org.sandev.basics.structs.SandStructMessage instance)
Mutator for instance

setInstance

public void setInstance(java.lang.Object instance)
Generic mutator for instance

getInstanceFlag

public static boolean getInstanceFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getInstanceDefaultValue

public static org.sandev.basics.structs.SandStructMessage getInstanceDefaultValue()
Default value for instance. Returns null

getInstanceInvalidValue

public static org.sandev.basics.structs.SandStructMessage getInstanceInvalidValue()
Invalid value for instance. Returns null

getInstancePrintValue

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

getInstanceFieldPrintValue

public java.lang.String getInstanceFieldPrintValue()
Return the print name of the instance field. If no printname is declared then this returns the field name.

getInstanceRange

public java.lang.String getInstanceRange()
Return the range specification for this field

getInstanceValidityCheck

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

getInstanceMetatype

public java.lang.String getInstanceMetatype()
Return the metatype text for this field, or "" if no metatype was declared.

getSource

public java.lang.String getSource()
Accessor for source

setSource

public void setSource(java.lang.String source)
Mutator for source

setSource

public void setSource(java.lang.Object source)
Generic mutator for source

getSourceFlag

public static boolean getSourceFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getSourceLengthNorm

public static int getSourceLengthNorm()
Normal source length is 40 characters

getSourceLengthMax

public static int getSourceLengthMax()
Maximum source length is 80 characters

getSourceDefaultValue

public static java.lang.String getSourceDefaultValue()
Default value for source. Returns ""

getSourceInvalidValue

public static java.lang.String getSourceInvalidValue()
Invalid value for source. Returns null

getSourcePrintValue

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

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

getSourceFieldPrintValue

public java.lang.String getSourceFieldPrintValue()
Return the print name of the source field. If no printname is declared then this returns the field name.

getSourceRange

public java.lang.String getSourceRange()
Return the range specification for this field

getSourceValidityCheck

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

getSourceMetatype

public java.lang.String getSourceMetatype()
Return the metatype text for this field, or "" if no metatype was declared.

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
<