org.sandev.basics.sandmessages
Class TestScript

java.lang.Object
  org.sandev.basics.structs.TestScriptStruct
      org.sandev.basics.sandmessages.TestScript

All Implemented Interfaces:

SandInstanceMessage, SandMessage, SandStructMessage, Resolvable

public class TestScript
extends TestScriptStruct
implements SandStructMessage, Resolvable

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

Field Summary

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

comment, configFile, createdData, initialData, testSteps

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

TestScript()
Default constructor calls init.

Method Summary

void	addCreatedData(SandPersistMessage element) Appends a value to createdData
void	addCreatedData(SandPersistMessage[] elements) Appends an array of values to createdData
void	addInitialData(SandPersistMessage element) Appends a value to initialData
void	addInitialData(SandPersistMessage[] elements) Appends an array of values to initialData
void	addTestSteps(TestStep element) Appends a value to testSteps
void	addTestSteps(TestStep[] elements) Appends an array of values to testSteps
void	clearCreatedData() Clears all values from createdData
void	clearInitialData() Clears all values from initialData
void	clearTestSteps() Clears all values from testSteps
SandInstanceMessage	cloneMessage() Calls cloneTestScript
TestScript	cloneTestScript() Make a deep copy of this TestScript.
SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(TestScript 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.
boolean	createdDataContains(SandPersistMessage val) Returns true if createdData contains the specified value.
int	createdDataIndexOf(SandPersistMessage val) Return the index of the specified value in createdData, or -1 if not found.
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
java.lang.String	getComment() Accessor for comment
static java.lang.String	getCommentDefaultValue() Default value for comment.
java.lang.String	getCommentFieldPrintValue() Return the print name of the comment field.
static boolean	getCommentFlag(int fieldflag) Field flag accessor.
static java.lang.String	getCommentInvalidValue() Invalid value for comment.
static int	getCommentLengthMax() Maximum comment length is 4096 characters
static int	getCommentLengthNorm() Normal comment length is 255 characters
java.lang.String	getCommentMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getCommentPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getCommentRange() Return the range specification for this field
java.lang.String	getCommentValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getConfigFile() Accessor for configFile
static java.lang.String	getConfigFileDefaultValue() Default value for configFile.
java.lang.String	getConfigFileFieldPrintValue() Return the print name of the configFile field.
static boolean	getConfigFileFlag(int fieldflag) Field flag accessor.
static java.lang.String	getConfigFileInvalidValue() Invalid value for configFile.
static int	getConfigFileLengthMax() Maximum configFile length is 128 characters
static int	getConfigFileLengthNorm() Normal configFile length is 40 characters
java.lang.String	getConfigFileMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getConfigFilePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getConfigFileRange() Return the range specification for this field
java.lang.String	getConfigFileValidityCheck() 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.
SandPersistMessage[]	getCreatedData() Accessor for createdData.
SandPersistMessage	getCreatedData(int index) Returns the element at the specified index.
static SandPersistMessage[]	getCreatedDataDefaultValue() Default value for createdData.
static SandPersistMessage	getCreatedDataElementInvalidValue() Invalid value for createdDataelement.
static boolean	getCreatedDataFlag(int fieldflag) Field flag accessor.
static SandPersistMessage[]	getCreatedDataInvalidValue() Invalid value for createdData.
java.lang.String	getCreatedDataMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getCreatedDataRange() Return the range specification for this field
java.lang.String	getCreatedDataValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
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[]	getInitialData() Accessor for initialData.
SandPersistMessage	getInitialData(int index) Returns the element at the specified index.
static SandPersistMessage[]	getInitialDataDefaultValue() Default value for initialData.
static SandPersistMessage	getInitialDataElementInvalidValue() Invalid value for initialDataelement.
static boolean	getInitialDataFlag(int fieldflag) Field flag accessor.
static SandPersistMessage[]	getInitialDataInvalidValue() Invalid value for initialData.
java.lang.String	getInitialDataMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getInitialDataRange() Return the range specification for this field
java.lang.String	getInitialDataValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandPersistMessage	getInstance(java.lang.String classname, long id) If this instance directly contains the specified instance, then find it and return it.
SandInstanceMessage	getInstance(java.lang.String classname, java.lang.String fieldname, java.lang.String value) If this instance directly contains the specified instance, then find it and return it.
java.lang.String	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
java.lang.String	getShortName() Returns the unqualified name of this message.
SandStructMessage	getStructMessage() Returns a new TestScript instance
TestStep[]	getTestSteps() Accessor for testSteps.
TestStep	getTestSteps(int index) Returns the element at the specified index.
static TestStep[]	getTestStepsDefaultValue() Default value for testSteps.
static TestStep	getTestStepsElementInvalidValue() Invalid value for testStepselement.
static boolean	getTestStepsFlag(int fieldflag) Field flag accessor.
static TestStep[]	getTestStepsInvalidValue() Invalid value for testSteps.
java.lang.String	getTestStepsMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getTestStepsRange() Return the range specification for this field
java.lang.String	getTestStepsValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandUpdateMessage	getUpdateMessage() Returns a new TestScriptUpdate 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	initialDataContains(SandPersistMessage val) Returns true if initialData contains the specified value.
int	initialDataIndexOf(SandPersistMessage val) Return the index of the specified value in initialData, or -1 if not found.
void	insertCreatedData(int index, SandPersistMessage value) Insert the specified element at the specified index.
void	insertInitialData(int index, SandPersistMessage value) Insert the specified element at the specified index.
void	insertTestSteps(int index, TestStep value) Insert the specified element at the specified index.
boolean	isEquivalent(SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, IDLookup idlookup, NameLookup namelookup, AuthUser au) Validate the references as specified in the Resolvable interface.
SandPersistMessage	removeCreatedData(int index) Remove the element at the specified index and return it.
boolean	removeCreatedDataValue(SandPersistMessage value) Removes the given element from createdData.
SandPersistMessage	removeInitialData(int index) Remove the element at the specified index and return it.
boolean	removeInitialDataValue(SandPersistMessage value) Removes the given element from initialData.
TestStep	removeTestSteps(int index) Remove the element at the specified index and return it.
boolean	removeTestStepsValue(TestStep value) Removes the given element from testSteps.
void	setComment(java.lang.Object comment) Generic mutator for comment
void	setComment(java.lang.String comment) Mutator for comment
void	setConfigFile(java.lang.Object configFile) Generic mutator for configFile
void	setConfigFile(java.lang.String configFile) Mutator for configFile
void	setCreatedData(int index, SandPersistMessage value) Set the value at the index specified.
void	setCreatedData(java.lang.Object[] createdData) Generic mutator for createdData
void	setCreatedData(SandPersistMessage[] createdData) Mutator for createdData
void	setInitialData(int index, SandPersistMessage value) Set the value at the index specified.
void	setInitialData(java.lang.Object[] initialData) Generic mutator for initialData
void	setInitialData(SandPersistMessage[] initialData) Mutator for initialData
void	setTestSteps(int index, TestStep value) Set the value at the index specified.
void	setTestSteps(java.lang.Object[] testSteps) Generic mutator for testSteps
void	setTestSteps(TestStep[] testSteps) Mutator for testSteps
int	sizeofCreatedData() Returns the size of createdData.
int	sizeofInitialData() Returns the size of initialData.
int	sizeofTestSteps() Returns the size of testSteps.
boolean	testStepsContains(TestStep val) Returns true if testSteps contains the specified value.
int	testStepsIndexOf(TestStep val) Return the index of the specified value in testSteps, or -1 if not found.
java.lang.String	toString() Return a string representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestScript

public TestScript()

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

getComment

public java.lang.String getComment()

Accessor for comment

setComment

public void setComment(java.lang.String comment)

Mutator for comment

setComment

public void setComment(java.lang.Object comment)

Generic mutator for comment

getCommentFlag

public static boolean getCommentFlag(int fieldflag)

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

getCommentLengthNorm

public static int getCommentLengthNorm()

Normal comment length is 255 characters

getCommentLengthMax

public static int getCommentLengthMax()

Maximum comment length is 4096 characters

getCommentDefaultValue

public static java.lang.String getCommentDefaultValue()

Default value for comment. Returns ""

getCommentInvalidValue

public static java.lang.String getCommentInvalidValue()

Invalid value for comment. Returns null

getCommentPrintValue

public java.lang.String getCommentPrintValue()

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.

getCommentFieldPrintValue

public java.lang.String getCommentFieldPrintValue()

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

getCommentRange

public java.lang.String getCommentRange()

Return the range specification for this field

getCommentValidityCheck

public java.lang.String getCommentValidityCheck()

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.

getCommentMetatype

public java.lang.String getCommentMetatype()

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

getConfigFile

public java.lang.String getConfigFile()

Accessor for configFile

setConfigFile

public void setConfigFile(java.lang.String configFile)

Mutator for configFile

setConfigFile

public void setConfigFile(java.lang.Object configFile)

Generic mutator for configFile

getConfigFileFlag

public static boolean getConfigFileFlag(int fieldflag)

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

getConfigFileLengthNorm

public static int getConfigFileLengthNorm()

Normal configFile length is 40 characters

getConfigFileLengthMax

public static int getConfigFileLengthMax()

Maximum configFile length is 128 characters

getConfigFileDefaultValue

public static java.lang.String getConfigFileDefaultValue()

Default value for configFile. Returns ""

getConfigFileInvalidValue

public static java.lang.String getConfigFileInvalidValue()

Invalid value for configFile. Returns "INVALID_CONFIG_FILENAME"

getConfigFilePrintValue

public java.lang.String getConfigFilePrintValue()

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.

getConfigFileFieldPrintValue

public java.lang.String getConfigFileFieldPrintValue()

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

getConfigFileRange

public java.lang.String getConfigFileRange()

Return the range specification for this field

getConfigFileValidityCheck

public java.lang.String getConfigFileValidityCheck()

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.

getConfigFileMetatype

public java.lang.String getConfigFileMetatype()

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

getInitialData

public SandPersistMessage[] getInitialData()

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

setInitialData

public void setInitialData(SandPersistMessage[] initialData)

Mutator for initialData

setInitialData

public void setInitialData(java.lang.Object[] initialData)

Generic mutator for initialData

addInitialData

public void addInitialData(SandPersistMessage element)

Appends a value to initialData

addInitialData

public void addInitialData(SandPersistMessage[] elements)

Appends an array of values to initialData

getInitialData

public SandPersistMessage getInitialData(int index)

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

setInitialData

public void setInitialData(int index,
                           SandPersistMessage value)

Set the value at the index specified.

insertInitialData

public void insertInitialData(int index,
                              SandPersistMessage 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.

removeInitialData

public SandPersistMessage removeInitialData(int index)

Remove the element at the specified index and return it.

removeInitialDataValue

public boolean removeInitialDataValue(SandPersistMessage value)

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

clearInitialData

public void clearInitialData()

Clears all values from initialData

initialDataContains

public boolean initialDataContains(SandPersistMessage val)

Returns true if initialData contains the specified value.

initialDataIndexOf

public int initialDataIndexOf(SandPersistMessage val)

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

sizeofInitialData

public int sizeofInitialData()

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

getInitialDataFlag

public static boolean getInitialDataFlag(int fieldflag)

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

getInitialDataDefaultValue

public static SandPersistMessage[] getInitialDataDefaultValue()

Default value for initialData. Returns new SandPersistMessage[0]

getInitialDataElementInvalidValue

public static SandPersistMessage getInitialDataElementInvalidValue()

Invalid value for initialDataelement. Returns null

getInitialDataInvalidValue

public static SandPersistMessage[] getInitialDataInvalidValue()

Invalid value for initialData. Returns null

getInitialDataRange

public java.lang.String getInitialDataRange()

Return the range specification for this field

getInitialDataValidityCheck

public java.lang.String getInitialDataValidityCheck()

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.

getInitialDataMetatype

public java.lang.String getInitialDataMetatype()

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

getTestSteps

public TestStep[] getTestSteps()

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

setTestSteps

public void setTestSteps(TestStep[] testSteps)

Mutator for testSteps

setTestSteps

public void setTestSteps(java.lang.Object[] testSteps)

Generic mutator for testSteps

addTestSteps

public void addTestSteps(TestStep element)

Appends a value to testSteps

addTestSteps

public void addTestSteps(TestStep[] elements)

Appends an array of values to testSteps

getTestSteps

public TestStep getTestSteps(int index)

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

setTestSteps

public void setTestSteps(int index,
                         TestStep value)

Set the value at the index specified.

insertTestSteps

public void insertTestSteps(int index,
                            TestStep 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.

removeTestSteps

public TestStep removeTestSteps(int index)

Remove the element at the specified index and return it.

removeTestStepsValue

public boolean removeTestStepsValue(TestStep value)

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

clearTestSteps

public void clearTestSteps()

Clears all values from testSteps

testStepsContains

public boolean testStepsContains(TestStep val)

Returns true if testSteps contains the specified value.

testStepsIndexOf

public int testStepsIndexOf(TestStep val)

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

sizeofTestSteps

public int sizeofTestSteps()

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

getTestStepsFlag

public static boolean getTestStepsFlag(int fieldflag)

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

getTestStepsDefaultValue

public static TestStep[] getTestStepsDefaultValue()

Default value for testSteps. Returns new TestStep[0]

getTestStepsElementInvalidValue

public static TestStep getTestStepsElementInvalidValue()

Invalid value for testStepselement. Returns null

getTestStepsInvalidValue

public static TestStep[] getTestStepsInvalidValue()

Invalid value for testSteps. Returns null

getTestStepsRange

public java.lang.String getTestStepsRange()

Return the range specification for this field

getTestStepsValidityCheck

public java.lang.String getTestStepsValidityCheck()

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.

getTestStepsMetatype

public java.lang.String getTestStepsMetatype()

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

getCreatedData

public SandPersistMessage[] getCreatedData()

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

setCreatedData

public void setCreatedData(SandPersistMessage[] createdData)

Mutator for createdData

setCreatedData

public void setCreatedData(java.lang.Object[] createdData)

Generic mutator for createdData

addCreatedData

public void addCreatedData(SandPersistMessage element)

Appends a value to createdData

addCreatedData

public void addCreatedData(SandPersistMessage[] elements)

Appends an array of values to createdData

getCreatedData

public SandPersistMessage getCreatedData(int index)

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

setCreatedData

public void setCreatedData(int index,
                           SandPersistMessage value)

Set the value at the index specified.

insertCreatedData

public void insertCreatedData(int index,
                              SandPersistMessage 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.

removeCreatedData

public SandPersistMessage removeCreatedData(int index)

Remove the element at the specified index and return it.

removeCreatedDataValue

public boolean removeCreatedDataValue(SandPersistMessage value)

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

clearCreatedData

public void clearCreatedData()

Clears all values from createdData

createdDataContains

public boolean createdDataContains(SandPersistMessage val)

Returns true if createdData contains the specified value.

createdDataIndexOf

public int createdDataIndexOf(SandPersistMessage val)

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

sizeofCreatedData

public int sizeofCreatedData()

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

getCreatedDataFlag

public static boolean getCreatedDataFlag(int fieldflag)

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

getCreatedDataDefaultValue

public static SandPersistMessage[] getCreatedDataDefaultValue()

Default value for createdData. Returns new SandPersistMessage[0]

getCreatedDataElementInvalidValue

public static SandPersistMessage getCreatedDataElementInvalidValue()

Invalid value for createdDataelement. Returns null

getCreatedDataInvalidValue

public static SandPersistMessage[] getCreatedDataInvalidValue()

Invalid value for createdData. Returns null

getCreatedDataRange

public java.lang.String getCreatedDataRange()

Return the range specification for this field

getCreatedDataValidityCheck

public java.lang.String getCreatedDataValidityCheck()

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.

getCreatedDataMetatype

public java.lang.String getCreatedDataMetatype()

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 TestScriptUpdate instance

Specified by:

getUpdateMessage in interface SandMessage

getStructMessage

public SandStructMessage getStructMessage()

Returns a new TestScript 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 cloneTestScript

Specified by:

cloneMessage in interface SandInstanceMessage

cloneTestScript

public TestScript cloneTestScript()

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

copyDataFrom

public void copyDataFrom(TestScript 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