org.sandev.basics.sandmessages
Class TestAction

java.lang.Object
  org.sandev.basics.structs.TestActionStruct
      org.sandev.basics.sandmessages.TestAction

All Implemented Interfaces:

SandInstanceMessage, SandMessage, SandStructMessage, Resolvable

public class TestAction
extends TestActionStruct
implements SandStructMessage, Resolvable

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

Field Summary

static int	COMMTYPE_ASYNC Possible value for commType
static int	COMMTYPE_SYNC Possible value for commType
static int	RETURNMSGSTATUS_STATUS_APPERROR Possible value for returnMsgStatus
static int	RETURNMSGSTATUS_STATUS_NORMAL Possible value for returnMsgStatus
static int	RETURNMSGSTATUS_STATUS_SANDERROR Possible value for returnMsgStatus
static int	RETURNMSGSTATUS_STATUS_SYSERROR Possible value for returnMsgStatus

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

commType, message, returnMsgStatus, targetNodeOverride

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

Constructor Summary

TestAction()
Default constructor calls init.

Method Summary

SandInstanceMessage	cloneMessage() Calls cloneTestAction
TestAction	cloneTestAction() Make a deep copy of this TestAction.
static java.lang.String	commTypeActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	commTypeLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	commTypeLabelToValueStatic(java.lang.String label)
static java.lang.String	commTypePrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	commTypePrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	commTypeValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	commTypeValueToLabelStatic(int val)
SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(TestAction other) Deep copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, SandInstanceMessage other) Copy the specified field from the given instance.
java.lang.String	debugDump(java.lang.String prefix) Dump this instance into a debug printable string.
void	defaultField(java.lang.String fieldname) Set the specified field to its default value.
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
boolean	fieldsValid() Validate the fields as specified in the SandInstanceMessage interface
SandAttrVal[]	fieldValidate(SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
SandCollectionMessage	find(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.
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.
SandCollectionMessage	getCollectionMessage() Returns null
int	getCommType() Accessor for commType
static java.lang.String[]	getCommTypeActualVals() Return an array of the possible values for this field as Strings.
static int	getCommTypeDefaultValue() Default value for commType.
static java.lang.String	getCommTypeEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getCommTypeFieldPrintValue() Return the print name of the commType field.
static boolean	getCommTypeFlag(int fieldflag) Field flag accessor.
static int	getCommTypeInvalidValue() Invalid value for commType.
static java.lang.String[]	getCommTypeKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getCommTypeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getCommTypePrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getCommTypePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getCommTypeRange() Return the range specification for this field
java.lang.String	getCommTypeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
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.
SandMessage	getMessage() Accessor for message
static SandMessage	getMessageDefaultValue() Default value for message.
java.lang.String	getMessageFieldPrintValue() Return the print name of the message field.
static boolean	getMessageFlag(int fieldflag) Field flag accessor.
static SandMessage	getMessageInvalidValue() Invalid value for message.
java.lang.String	getMessageMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getMessagePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getMessageRange() Return the range specification for this field
java.lang.String	getMessageValidityCheck() 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	getReturnMsgStatus() Accessor for returnMsgStatus
static java.lang.String[]	getReturnMsgStatusActualVals() Return an array of the possible values for this field as Strings.
static int	getReturnMsgStatusDefaultValue() Default value for returnMsgStatus.
static java.lang.String	getReturnMsgStatusEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getReturnMsgStatusFieldPrintValue() Return the print name of the returnMsgStatus field.
static boolean	getReturnMsgStatusFlag(int fieldflag) Field flag accessor.
static int	getReturnMsgStatusInvalidValue() Invalid value for returnMsgStatus.
static java.lang.String[]	getReturnMsgStatusKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getReturnMsgStatusMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getReturnMsgStatusPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getReturnMsgStatusPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getReturnMsgStatusRange() Return the range specification for this field
java.lang.String	getReturnMsgStatusValidityCheck() 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 TestAction instance
java.lang.String	getTargetNodeOverride() Accessor for targetNodeOverride
static java.lang.String	getTargetNodeOverrideDefaultValue() Default value for targetNodeOverride.
java.lang.String	getTargetNodeOverrideFieldPrintValue() Return the print name of the targetNodeOverride field.
static boolean	getTargetNodeOverrideFlag(int fieldflag) Field flag accessor.
static java.lang.String	getTargetNodeOverrideInvalidValue() Invalid value for targetNodeOverride.
static int	getTargetNodeOverrideLengthMax() Maximum targetNodeOverride length is 60 characters
static int	getTargetNodeOverrideLengthNorm() Normal targetNodeOverride length is 30 characters
java.lang.String	getTargetNodeOverrideMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getTargetNodeOverridePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getTargetNodeOverrideRange() Return the range specification for this field
java.lang.String	getTargetNodeOverrideValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandUpdateMessage	getUpdateMessage() Returns a new TestActionUpdate instance
java.lang.String	getValueForFieldName(java.lang.String fieldname, IDLookup lookup, AuthUser user, java.lang.String defaultVal) Returns the print representation of the value of the specified field, or the given default value if innaccessible.
void	init() Initialize all fields to their default values
boolean	isEquivalent(SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, IDLookup idlookup, NameLookup namelookup, AuthUser au) Validate the references as specified in the Resolvable interface.
static java.lang.String	returnMsgStatusActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	returnMsgStatusLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	returnMsgStatusLabelToValueStatic(java.lang.String label)
static java.lang.String	returnMsgStatusPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	returnMsgStatusPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	returnMsgStatusValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	returnMsgStatusValueToLabelStatic(int val)
void	setCommType(int commType) Mutator for commType
void	setMessage(java.lang.Object message) Generic mutator for message
void	setMessage(SandMessage message) Mutator for message
void	setReturnMsgStatus(int returnMsgStatus) Mutator for returnMsgStatus
void	setTargetNodeOverride(java.lang.Object targetNodeOverride) Generic mutator for targetNodeOverride
void	setTargetNodeOverride(java.lang.String targetNodeOverride) Mutator for targetNodeOverride
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

COMMTYPE_SYNC

public static final int COMMTYPE_SYNC

Possible value for commType

See Also:

Constant Field Values

COMMTYPE_ASYNC

public static final int COMMTYPE_ASYNC

Possible value for commType

See Also:

Constant Field Values

RETURNMSGSTATUS_STATUS_NORMAL

public static final int RETURNMSGSTATUS_STATUS_NORMAL

Possible value for returnMsgStatus

See Also:

Constant Field Values

RETURNMSGSTATUS_STATUS_SYSERROR

public static final int RETURNMSGSTATUS_STATUS_SYSERROR

Possible value for returnMsgStatus

See Also:

Constant Field Values

RETURNMSGSTATUS_STATUS_SANDERROR

public static final int RETURNMSGSTATUS_STATUS_SANDERROR

Possible value for returnMsgStatus

See Also:

Constant Field Values

RETURNMSGSTATUS_STATUS_APPERROR

public static final int RETURNMSGSTATUS_STATUS_APPERROR

Possible value for returnMsgStatus

See Also:

Constant Field Values

Constructor Detail

TestAction

public TestAction()

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

getCommType

public int getCommType()

Accessor for commType

setCommType

public void setCommType(int commType)

Mutator for commType

commTypeValueToLabel

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

commTypeValueToLabelStatic

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

commTypeLabelToValue

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

commTypeLabelToValueStatic

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

getCommTypePrintVals

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

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.

getCommTypeKeyVals

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

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.

getCommTypeActualVals

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

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

commTypePrint2Key

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

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

commTypePrint2Actual

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

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

commTypeActual2Print

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

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

getCommTypeEnumSummary

public static java.lang.String getCommTypeEnumSummary()

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

getCommTypeFlag

public static boolean getCommTypeFlag(int fieldflag)

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

getCommTypeDefaultValue

public static int getCommTypeDefaultValue()

Default value for commType. Returns 0

getCommTypeInvalidValue

public static int getCommTypeInvalidValue()

Invalid value for commType. Returns -1

getCommTypePrintValue

public java.lang.String getCommTypePrintValue()

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.

getCommTypeFieldPrintValue

public java.lang.String getCommTypeFieldPrintValue()

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

getCommTypeRange

public java.lang.String getCommTypeRange()

Return the range specification for this field

getCommTypeValidityCheck

public java.lang.String getCommTypeValidityCheck()

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.

getCommTypeMetatype

public java.lang.String getCommTypeMetatype()

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

getTargetNodeOverride

public java.lang.String getTargetNodeOverride()

Accessor for targetNodeOverride

setTargetNodeOverride

public void setTargetNodeOverride(java.lang.String targetNodeOverride)

Mutator for targetNodeOverride

setTargetNodeOverride

public void setTargetNodeOverride(java.lang.Object targetNodeOverride)

Generic mutator for targetNodeOverride

getTargetNodeOverrideFlag

public static boolean getTargetNodeOverrideFlag(int fieldflag)

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

getTargetNodeOverrideLengthNorm

public static int getTargetNodeOverrideLengthNorm()

Normal targetNodeOverride length is 30 characters

getTargetNodeOverrideLengthMax

public static int getTargetNodeOverrideLengthMax()

Maximum targetNodeOverride length is 60 characters

getTargetNodeOverrideDefaultValue

public static java.lang.String getTargetNodeOverrideDefaultValue()

Default value for targetNodeOverride. Returns ""

getTargetNodeOverrideInvalidValue

public static java.lang.String getTargetNodeOverrideInvalidValue()

Invalid value for targetNodeOverride. Returns null

getTargetNodeOverridePrintValue

public java.lang.String getTargetNodeOverridePrintValue()

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.

getTargetNodeOverrideFieldPrintValue

public java.lang.String getTargetNodeOverrideFieldPrintValue()

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

getTargetNodeOverrideRange

public java.lang.String getTargetNodeOverrideRange()

Return the range specification for this field

getTargetNodeOverrideValidityCheck

public java.lang.String getTargetNodeOverrideValidityCheck()

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.

getTargetNodeOverrideMetatype

public java.lang.String getTargetNodeOverrideMetatype()

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

getMessage

public SandMessage getMessage()

Accessor for message

setMessage

public void setMessage(SandMessage message)

Mutator for message

setMessage

public void setMessage(java.lang.Object message)

Generic mutator for message

getMessageFlag

public static boolean getMessageFlag(int fieldflag)

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

getMessageDefaultValue

public static SandMessage getMessageDefaultValue()

Default value for message. Returns null

getMessageInvalidValue

public static SandMessage getMessageInvalidValue()

Invalid value for message. Returns null

getMessagePrintValue

public java.lang.String getMessagePrintValue()

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.

getMessageFieldPrintValue

public java.lang.String getMessageFieldPrintValue()

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

getMessageRange

public java.lang.String getMessageRange()

Return the range specification for this field

getMessageValidityCheck

public java.lang.String getMessageValidityCheck()

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.

getMessageMetatype

public java.lang.String getMessageMetatype()

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

getReturnMsgStatus

public int getReturnMsgStatus()

Accessor for returnMsgStatus

setReturnMsgStatus

public void setReturnMsgStatus(int returnMsgStatus)

Mutator for returnMsgStatus

returnMsgStatusValueToLabel

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

returnMsgStatusValueToLabelStatic

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

returnMsgStatusLabelToValue

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

returnMsgStatusLabelToValueStatic

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

getReturnMsgStatusPrintVals

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

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.

getReturnMsgStatusKeyVals

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

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.

getReturnMsgStatusActualVals

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

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

returnMsgStatusPrint2Key

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

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

returnMsgStatusPrint2Actual

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

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

returnMsgStatusActual2Print

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

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

getReturnMsgStatusEnumSummary

public static java.lang.String getReturnMsgStatusEnumSummary()

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

getReturnMsgStatusFlag

public static boolean getReturnMsgStatusFlag(int fieldflag)

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

getReturnMsgStatusDefaultValue

public static int getReturnMsgStatusDefaultValue()

Default value for returnMsgStatus. Returns 0

getReturnMsgStatusInvalidValue

public static int getReturnMsgStatusInvalidValue()

Invalid value for returnMsgStatus. Returns -1

getReturnMsgStatusPrintValue

public java.lang.String getReturnMsgStatusPrintValue()

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.

getReturnMsgStatusFieldPrintValue

public java.lang.String getReturnMsgStatusFieldPrintValue()

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

getReturnMsgStatusRange

public java.lang.String getReturnMsgStatusRange()

Return the range specification for this field

getReturnMsgStatusValidityCheck

public java.lang.String getReturnMsgStatusValidityCheck()

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.

getReturnMsgStatusMetatype

public java.lang.String getReturnMsgStatusMetatype()

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 SandMessage

getQueryMessage

public SandQueryMessage getQueryMessage()

Returns null

Specified by:

getQueryMessage in interface SandMessage

getCollectionMessage

public SandCollectionMessage getCollectionMessage()

Returns null

Specified by:

getCollectionMessage in interface SandMessage

getUpdateMessage

public SandUpdateMessage getUpdateMessage()

Returns a new TestActionUpdate instance

Specified by:

getUpdateMessage in interface SandMessage

getStructMessage

public SandStructMessage getStructMessage()

Returns a new TestAction instance

Specified by:

getStructMessage in interface SandMessage

isEquivalent

public boolean isEquivalent(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 SandMessage

generalModifier

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

General mutator method. Specified by SandInstanceMessage interface.

Specified by:

generalModifier in interface SandInstanceMessage

Throws:

SandException

generalDereference

public SandAttrVal generalDereference(java.lang.String fieldspec)

General reference field accessor method. Specified by SandInstanceMessage interface.

Specified by:

generalDereference in interface SandInstanceMessage

generalAccessor

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

General field accessor method. Specified by SandInstanceMessage interface.

Specified by:

generalAccessor in interface SandInstanceMessage

getDisplayFields

public java.lang.String[] getDisplayFields()

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

Specified by:

getDisplayFields in interface SandInstanceMessage

getDisplayFieldsPrint

public java.lang.String[] getDisplayFieldsPrint()

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

Specified by:

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

getDisplayValues

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

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

Specified by:

getDisplayValues in interface Resolvable

getValueForFieldName

public 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. A field value may be innaccessible due to authorization, null reference, or other call failure.

getAllFields

public java.lang.String[] getAllFields()

Return an array of all fields for this class.

Specified by:

getAllFields in interface SandInstanceMessage

getContainedMessageFields

public java.lang.String[] getContainedMessageFields()

Return an array of all contained message fields.

Specified by:

getContainedMessageFields in interface SandInstanceMessage

defaultField

public void defaultField(java.lang.String fieldname)

Set the specified field to its default value.

Specified by:

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

cloneMessage

public SandInstanceMessage cloneMessage()

Calls cloneTestAction

Specified by:

cloneMessage in interface SandInstanceMessage

cloneTestAction

public TestAction cloneTestAction()

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

copyDataFrom

public void copyDataFrom(TestAction 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,
                           SandInstanceMessage other)

Copy the specified field from the given instance.

Specified by:

copyFieldValue in interface SandInstanceMessage

fieldValidate

public SandAttrVal[] fieldValidate(SandAttrVal[] checkFields)

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

fieldValidate in interface SandInstanceMessage

fieldsValid

public boolean fieldsValid()

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

fieldsValid in interface SandInstanceMessage

referenceValidate

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

Validate the references as specified in the Resolvable interface.

Specified by:

referenceValidate in interface Resolvable

Throws:

SandException

convertToSuperstructClass

public 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 SandInstanceMessage

debugDump

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

Dump this instance into a debug printable string.

Specified by:

debugDump in interface SandInstanceMessage

getDisplayID

public java.lang.String getDisplayID()

Return the displayID for this message instance

Specified by:

getDisplayID in interface SandInstanceMessage

getInstance

public 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 SandStructMessage

getInstance

public 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 SandStructMessage

find

public SandCollectionMessage find(SandQueryMessage sqm)

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

Specified by:

find in interface 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