org.sandev.basics.sandmessages
Class TestScript

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

All Implemented Interfaces:

Resolvable, SandInstanceMessage, SandMessage, SandStructMessage

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: Dec 2, 2005 6:38:50 PM

Field Summary

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

asynchIn, asynchOut, queriesToAccept, queriesToMake, validatorClass

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

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_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET

Constructor Summary

TestScript()
Default constructor calls init.

Method Summary

void	addAsynchIn(DeliveryStream element) Appends a value to asynchIn
void	addAsynchIn(DeliveryStream[] elements) Appends an array of values to asynchIn
void	addAsynchOut(SandMessage element) Appends a value to asynchOut
void	addAsynchOut(SandMessage[] elements) Appends an array of values to asynchOut
void	addQueriesToAccept(ReceiveReturn element) Appends a value to queriesToAccept
void	addQueriesToAccept(ReceiveReturn[] elements) Appends an array of values to queriesToAccept
void	addQueriesToMake(CallResponse element) Appends a value to queriesToMake
void	addQueriesToMake(CallResponse[] elements) Appends an array of values to queriesToMake
boolean	asynchInContains(DeliveryStream val) Returns true if asynchIn contains the specified value.
int	asynchInIndexOf(DeliveryStream val) Return the index of the specified value in asynchIn, or -1 if not found.
boolean	asynchOutContains(SandMessage val) Returns true if asynchOut contains the specified value.
int	asynchOutIndexOf(SandMessage val) Return the index of the specified value in asynchOut, or -1 if not found.
void	clearAsynchIn() Clears all values from asynchIn
void	clearAsynchOut() Clears all values from asynchOut
void	clearQueriesToAccept() Clears all values from queriesToAccept
void	clearQueriesToMake() Clears all values from queriesToMake
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.
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
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.
DeliveryStream[]	getAsynchIn() Accessor for asynchIn
DeliveryStream	getAsynchIn(int index) Returns the element at the specified index.
static DeliveryStream[]	getAsynchInDefaultValue() Default value for asynchIn.
static DeliveryStream	getAsynchInElementInvalidValue() Invalid value for asynchInelement.
static boolean	getAsynchInFlag(int fieldflag) Field flag accessor.
static DeliveryStream[]	getAsynchInInvalidValue() Invalid value for asynchIn.
java.lang.String	getAsynchInMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getAsynchInRange() Return the range specification for this field
java.lang.String	getAsynchInValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandMessage[]	getAsynchOut() Accessor for asynchOut
SandMessage	getAsynchOut(int index) Returns the element at the specified index.
static SandMessage[]	getAsynchOutDefaultValue() Default value for asynchOut.
static SandMessage	getAsynchOutElementInvalidValue() Invalid value for asynchOutelement.
static boolean	getAsynchOutFlag(int fieldflag) Field flag accessor.
static SandMessage[]	getAsynchOutInvalidValue() Invalid value for asynchOut.
java.lang.String	getAsynchOutMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getAsynchOutRange() Return the range specification for this field
java.lang.String	getAsynchOutValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandCollectionMessage	getCollectionMessage() Returns null
java.lang.String[]	getDisplayFields() Return an array of the summary field names for this class.
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.
ReceiveReturn[]	getQueriesToAccept() Accessor for queriesToAccept
ReceiveReturn	getQueriesToAccept(int index) Returns the element at the specified index.
static ReceiveReturn[]	getQueriesToAcceptDefaultValue() Default value for queriesToAccept.
static ReceiveReturn	getQueriesToAcceptElementInvalidValue() Invalid value for queriesToAcceptelement.
static boolean	getQueriesToAcceptFlag(int fieldflag) Field flag accessor.
static ReceiveReturn[]	getQueriesToAcceptInvalidValue() Invalid value for queriesToAccept.
java.lang.String	getQueriesToAcceptMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getQueriesToAcceptRange() Return the range specification for this field
java.lang.String	getQueriesToAcceptValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
CallResponse[]	getQueriesToMake() Accessor for queriesToMake
CallResponse	getQueriesToMake(int index) Returns the element at the specified index.
static CallResponse[]	getQueriesToMakeDefaultValue() Default value for queriesToMake.
static CallResponse	getQueriesToMakeElementInvalidValue() Invalid value for queriesToMakeelement.
static boolean	getQueriesToMakeFlag(int fieldflag) Field flag accessor.
static CallResponse[]	getQueriesToMakeInvalidValue() Invalid value for queriesToMake.
java.lang.String	getQueriesToMakeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getQueriesToMakeRange() Return the range specification for this field
java.lang.String	getQueriesToMakeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandQueryMessage	getQueryMessage() Returns null
java.lang.String	getShortName() Returns the unqualified name of this message.
SandStructMessage	getStructMessage() Returns a new TestScript instance
SandUpdateMessage	getUpdateMessage() Returns null
java.lang.String	getValidatorClass() Accessor for validatorClass
static java.lang.String	getValidatorClassDefaultValue() Default value for validatorClass.
java.lang.String	getValidatorClassFieldPrintValue() Return the print name of the validatorClass field.
static boolean	getValidatorClassFlag(int fieldflag) Field flag accessor.
static java.lang.String	getValidatorClassInvalidValue() Invalid value for validatorClass.
static int	getValidatorClassLengthMax() Maximum validatorClass length is 80 characters
static int	getValidatorClassLengthNorm() Normal validatorClass length is 60 characters
java.lang.String	getValidatorClassMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getValidatorClassPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getValidatorClassRange() Return the range specification for this field
java.lang.String	getValidatorClassValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getValueForFieldName(java.lang.String fieldname, IDLookup lookup, AuthUser user, java.lang.String defaultVal) Returns the print representation of the value of the specified field, or the given default value if innaccessible.
void	init() Initialize all fields to their default values
void	insertAsynchIn(int index, DeliveryStream value) Insert the specified element at the specified index.
void	insertAsynchOut(int index, SandMessage value) Insert the specified element at the specified index.
void	insertQueriesToAccept(int index, ReceiveReturn value) Insert the specified element at the specified index.
void	insertQueriesToMake(int index, CallResponse value) Insert the specified element at the specified index.
boolean	isEquivalent(SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
boolean	queriesToAcceptContains(ReceiveReturn val) Returns true if queriesToAccept contains the specified value.
int	queriesToAcceptIndexOf(ReceiveReturn val) Return the index of the specified value in queriesToAccept, or -1 if not found.
boolean	queriesToMakeContains(CallResponse val) Returns true if queriesToMake contains the specified value.
int	queriesToMakeIndexOf(CallResponse val) Return the index of the specified value in queriesToMake, or -1 if not found.
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, IDLookup idlookup, NameLookup namelookup, AuthUser au) Validate the references as specified in the Resolvable interface.
DeliveryStream	removeAsynchIn(int index) Remove the element at the specified index and return it.
boolean	removeAsynchInValue(DeliveryStream value) Removes the given element from asynchIn.
SandMessage	removeAsynchOut(int index) Remove the element at the specified index and return it.
boolean	removeAsynchOutValue(SandMessage value) Removes the given element from asynchOut.
ReceiveReturn	removeQueriesToAccept(int index) Remove the element at the specified index and return it.
boolean	removeQueriesToAcceptValue(ReceiveReturn value) Removes the given element from queriesToAccept.
CallResponse	removeQueriesToMake(int index) Remove the element at the specified index and return it.
boolean	removeQueriesToMakeValue(CallResponse value) Removes the given element from queriesToMake.
void	setAsynchIn(DeliveryStream[] asynchIn) Mutator for asynchIn
void	setAsynchIn(int index, DeliveryStream value) Set the value at the index specified.
void	setAsynchIn(java.lang.Object[] asynchIn) Generic mutator for asynchIn
void	setAsynchOut(int index, SandMessage value) Set the value at the index specified.
void	setAsynchOut(java.lang.Object[] asynchOut) Generic mutator for asynchOut
void	setAsynchOut(SandMessage[] asynchOut) Mutator for asynchOut
void	setQueriesToAccept(int index, ReceiveReturn value) Set the value at the index specified.
void	setQueriesToAccept(java.lang.Object[] queriesToAccept) Generic mutator for queriesToAccept
void	setQueriesToAccept(ReceiveReturn[] queriesToAccept) Mutator for queriesToAccept
void	setQueriesToMake(CallResponse[] queriesToMake) Mutator for queriesToMake
void	setQueriesToMake(int index, CallResponse value) Set the value at the index specified.
void	setQueriesToMake(java.lang.Object[] queriesToMake) Generic mutator for queriesToMake
void	setValidatorClass(java.lang.Object validatorClass) Generic mutator for validatorClass
void	setValidatorClass(java.lang.String validatorClass) Mutator for validatorClass
int	sizeofAsynchIn() Returns the size of asynchIn.
int	sizeofAsynchOut() Returns the size of asynchOut.
int	sizeofQueriesToAccept() Returns the size of queriesToAccept.
int	sizeofQueriesToMake() Returns the size of queriesToMake.
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

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

getValidatorClass

public java.lang.String getValidatorClass()

Accessor for validatorClass

setValidatorClass

public void setValidatorClass(java.lang.String validatorClass)

Mutator for validatorClass

setValidatorClass

public void setValidatorClass(java.lang.Object validatorClass)

Generic mutator for validatorClass

getValidatorClassFlag

public static boolean getValidatorClassFlag(int fieldflag)

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

getValidatorClassLengthNorm

public static int getValidatorClassLengthNorm()

Normal validatorClass length is 60 characters

getValidatorClassLengthMax

public static int getValidatorClassLengthMax()

Maximum validatorClass length is 80 characters

getValidatorClassDefaultValue

public static java.lang.String getValidatorClassDefaultValue()

Default value for validatorClass. Returns ""

getValidatorClassInvalidValue

public static java.lang.String getValidatorClassInvalidValue()

Invalid value for validatorClass. Returns "SANDEV_INVALID_VALIDATOR_CLASS"

getValidatorClassPrintValue

public java.lang.String getValidatorClassPrintValue()

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.

getValidatorClassFieldPrintValue

public java.lang.String getValidatorClassFieldPrintValue()

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

getValidatorClassRange

public java.lang.String getValidatorClassRange()

Return the range specification for this field

getValidatorClassValidityCheck

public java.lang.String getValidatorClassValidityCheck()

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.

getValidatorClassMetatype

public java.lang.String getValidatorClassMetatype()

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

getAsynchIn

public DeliveryStream[] getAsynchIn()

Accessor for asynchIn

setAsynchIn

public void setAsynchIn(DeliveryStream[] asynchIn)

Mutator for asynchIn

setAsynchIn

public void setAsynchIn(java.lang.Object[] asynchIn)

Generic mutator for asynchIn

addAsynchIn

public void addAsynchIn(DeliveryStream element)

Appends a value to asynchIn

addAsynchIn

public void addAsynchIn(DeliveryStream[] elements)

Appends an array of values to asynchIn

getAsynchIn

public DeliveryStream getAsynchIn(int index)

Returns the element at the specified index. Returns null/-1 if the index was out of bounds.

setAsynchIn

public void setAsynchIn(int index,
                        DeliveryStream value)

Set the value at the index specified.

insertAsynchIn

public void insertAsynchIn(int index,
                           DeliveryStream 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.

removeAsynchIn

public DeliveryStream removeAsynchIn(int index)

Remove the element at the specified index and return it.

removeAsynchInValue

public boolean removeAsynchInValue(DeliveryStream value)

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

clearAsynchIn

public void clearAsynchIn()

Clears all values from asynchIn

asynchInContains

public boolean asynchInContains(DeliveryStream val)

Returns true if asynchIn contains the specified value.

asynchInIndexOf

public int asynchInIndexOf(DeliveryStream val)

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

sizeofAsynchIn

public int sizeofAsynchIn()

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

getAsynchInFlag

public static boolean getAsynchInFlag(int fieldflag)

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

getAsynchInDefaultValue

public static DeliveryStream[] getAsynchInDefaultValue()

Default value for asynchIn. Returns new DeliveryStream[0]

getAsynchInElementInvalidValue

public static DeliveryStream getAsynchInElementInvalidValue()

Invalid value for asynchInelement. Returns null

getAsynchInInvalidValue

public static DeliveryStream[] getAsynchInInvalidValue()

Invalid value for asynchIn. Returns null

getAsynchInRange

public java.lang.String getAsynchInRange()

Return the range specification for this field

getAsynchInValidityCheck

public java.lang.String getAsynchInValidityCheck()

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.

getAsynchInMetatype

public java.lang.String getAsynchInMetatype()

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

getAsynchOut

public SandMessage[] getAsynchOut()

Accessor for asynchOut

setAsynchOut

public void setAsynchOut(SandMessage[] asynchOut)

Mutator for asynchOut

setAsynchOut

public void setAsynchOut(java.lang.Object[] asynchOut)

Generic mutator for asynchOut

addAsynchOut

public void addAsynchOut(SandMessage element)

Appends a value to asynchOut

addAsynchOut

public void addAsynchOut(SandMessage[] elements)

Appends an array of values to asynchOut

getAsynchOut

public SandMessage getAsynchOut(int index)

Returns the element at the specified index. Returns null/-1 if the index was out of bounds.

setAsynchOut

public void setAsynchOut(int index,
                         SandMessage value)

Set the value at the index specified.

insertAsynchOut

public void insertAsynchOut(int index,
                            SandMessage 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.

removeAsynchOut

public SandMessage removeAsynchOut(int index)

Remove the element at the specified index and return it.

removeAsynchOutValue

public boolean removeAsynchOutValue(SandMessage value)

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

clearAsynchOut

public void clearAsynchOut()

Clears all values from asynchOut

asynchOutContains

public boolean asynchOutContains(SandMessage val)

Returns true if asynchOut contains the specified value.

asynchOutIndexOf

public int asynchOutIndexOf(SandMessage val)

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

sizeofAsynchOut

public int sizeofAsynchOut()

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

getAsynchOutFlag

public static boolean getAsynchOutFlag(int fieldflag)

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

getAsynchOutDefaultValue

public static SandMessage[] getAsynchOutDefaultValue()

Default value for asynchOut. Returns new SandMessage[0]

getAsynchOutElementInvalidValue

public static SandMessage getAsynchOutElementInvalidValue()

Invalid value for asynchOutelement. Returns null

getAsynchOutInvalidValue

public static SandMessage[] getAsynchOutInvalidValue()

Invalid value for asynchOut. Returns null

getAsynchOutRange

public java.lang.String getAsynchOutRange()

Return the range specification for this field

getAsynchOutValidityCheck

public java.lang.String getAsynchOutValidityCheck()

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.

getAsynchOutMetatype

public java.lang.String getAsynchOutMetatype()

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

getQueriesToMake

public CallResponse[] getQueriesToMake()

Accessor for queriesToMake

setQueriesToMake

public void setQueriesToMake(CallResponse[] queriesToMake)

Mutator for queriesToMake

setQueriesToMake

public void setQueriesToMake(java.lang.Object[] queriesToMake)

Generic mutator for queriesToMake

addQueriesToMake

public void addQueriesToMake(CallResponse element)

Appends a value to queriesToMake

addQueriesToMake

public void addQueriesToMake(CallResponse[] elements)

Appends an array of values to queriesToMake

getQueriesToMake

public CallResponse getQueriesToMake(int index)

Returns the element at the specified index. Returns null/-1 if the index was out of bounds.

setQueriesToMake

public void setQueriesToMake(int index,
                             CallResponse value)

Set the value at the index specified.

insertQueriesToMake

public void insertQueriesToMake(int index,
                                CallResponse 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.

removeQueriesToMake

public CallResponse removeQueriesToMake(int index)

Remove the element at the specified index and return it.

removeQueriesToMakeValue

public boolean removeQueriesToMakeValue(CallResponse value)

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

clearQueriesToMake

public void clearQueriesToMake()

Clears all values from queriesToMake

queriesToMakeContains

public boolean queriesToMakeContains(CallResponse val)

Returns true if queriesToMake contains the specified value.

queriesToMakeIndexOf

public int queriesToMakeIndexOf(CallResponse val)

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

sizeofQueriesToMake

public int sizeofQueriesToMake()

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

getQueriesToMakeFlag

public static boolean getQueriesToMakeFlag(int fieldflag)

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

getQueriesToMakeDefaultValue

public static CallResponse[] getQueriesToMakeDefaultValue()

Default value for queriesToMake. Returns new CallResponse[0]

getQueriesToMakeElementInvalidValue

public static CallResponse getQueriesToMakeElementInvalidValue()

Invalid value for queriesToMakeelement. Returns null

getQueriesToMakeInvalidValue

public static CallResponse[] getQueriesToMakeInvalidValue()

Invalid value for queriesToMake. Returns null

getQueriesToMakeRange

public java.lang.String getQueriesToMakeRange()

Return the range specification for this field

getQueriesToMakeValidityCheck

public java.lang.String getQueriesToMakeValidityCheck()

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.

getQueriesToMakeMetatype

public java.lang.String getQueriesToMakeMetatype()

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

getQueriesToAccept

public ReceiveReturn[] getQueriesToAccept()

Accessor for queriesToAccept

setQueriesToAccept

public void setQueriesToAccept(ReceiveReturn[] queriesToAccept)

Mutator for queriesToAccept

setQueriesToAccept

public void setQueriesToAccept(java.lang.Object[] queriesToAccept)

Generic mutator for queriesToAccept

addQueriesToAccept

public void addQueriesToAccept(ReceiveReturn element)

Appends a value to queriesToAccept

addQueriesToAccept

public void addQueriesToAccept(ReceiveReturn[] elements)

Appends an array of values to queriesToAccept

getQueriesToAccept

public ReceiveReturn getQueriesToAccept(int index)

Returns the element at the specified index. Returns null/-1 if the index was out of bounds.

setQueriesToAccept

public void setQueriesToAccept(int index,
                               ReceiveReturn value)

Set the value at the index specified.

insertQueriesToAccept

public void insertQueriesToAccept(int index,
                                  ReceiveReturn 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.

removeQueriesToAccept

public ReceiveReturn removeQueriesToAccept(int index)

Remove the element at the specified index and return it.

removeQueriesToAcceptValue

public boolean removeQueriesToAcceptValue(ReceiveReturn value)

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

clearQueriesToAccept

public void clearQueriesToAccept()

Clears all values from queriesToAccept

queriesToAcceptContains

public boolean queriesToAcceptContains(ReceiveReturn val)

Returns true if queriesToAccept contains the specified value.

queriesToAcceptIndexOf

public int queriesToAcceptIndexOf(ReceiveReturn val)

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

sizeofQueriesToAccept

public int sizeofQueriesToAccept()

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

getQueriesToAcceptFlag

public static boolean getQueriesToAcceptFlag(int fieldflag)

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

getQueriesToAcceptDefaultValue

public static ReceiveReturn[] getQueriesToAcceptDefaultValue()

Default value for queriesToAccept. Returns new ReceiveReturn[0]

getQueriesToAcceptElementInvalidValue

public static ReceiveReturn getQueriesToAcceptElementInvalidValue()

Invalid value for queriesToAcceptelement. Returns null

getQueriesToAcceptInvalidValue

public static ReceiveReturn[] getQueriesToAcceptInvalidValue()

Invalid value for queriesToAccept. Returns null

getQueriesToAcceptRange

public java.lang.String getQueriesToAcceptRange()

Return the range specification for this field

getQueriesToAcceptValidityCheck

public java.lang.String getQueriesToAcceptValidityCheck()

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.

getQueriesToAcceptMetatype

public java.lang.String getQueriesToAcceptMetatype()

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 null

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.

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

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.

toString

public java.lang.String toString()

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

getAllFields

public java.lang.String[] getAllFields()

Return an array of all fields for this class.

Specified by:

getAllFields 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

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,