org.sandev.basics.sandmessages
Class TestCondition

java.lang.Object
  org.sandev.basics.structs.TestConditionStruct
      org.sandev.basics.sandmessages.TestCondition

All Implemented Interfaces:

SandInstanceMessage, SandMessage, SandStructMessage, Resolvable

public class TestCondition
extends TestConditionStruct
implements SandStructMessage, Resolvable

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

Field Summary

static int	COMMTYPE_ASYNC Possible value for commType
static int	COMMTYPE_SYNC Possible value for commType

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

commType, matchInfo, msgClass

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

TestCondition()
Default constructor calls init.

Method Summary

void	addMatchInfo(SandAttrVal element) Appends a value to matchInfo
void	addMatchInfo(SandAttrVal[] elements) Appends an array of values to matchInfo
void	clearMatchInfo() Clears all values from matchInfo
SandInstanceMessage	cloneMessage() Calls cloneTestCondition
TestCondition	cloneTestCondition() Make a deep copy of this TestCondition.
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(TestCondition other, boolean deepcopy) 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.
int	getBaseMemoryUse() Return the base memory use for this object.
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.
java.lang.String	getLayoutXML() Return the fieldlayout XML or null if not defined.
SandAttrVal[]	getMatchInfo() Accessor for matchInfo.
SandAttrVal	getMatchInfo(int index) Returns the element at the specified index.
static SandAttrVal[]	getMatchInfoDefaultValue() Default value for matchInfo.
static SandAttrVal	getMatchInfoElementInvalidValue() Invalid value for matchInfoelement.
java.lang.String	getMatchInfoFieldPrintValue() Return the print name of the matchInfo field.
static boolean	getMatchInfoFlag(int fieldflag) Field flag accessor.
static SandAttrVal[]	getMatchInfoInvalidValue() Invalid value for matchInfo.
java.lang.String	getMatchInfoMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getMatchInfoPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getMatchInfoRange() Return the range specification for this field
java.lang.String	getMatchInfoValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getMsgClass() Accessor for msgClass
static java.lang.String	getMsgClassDefaultValue() Default value for msgClass.
java.lang.String	getMsgClassFieldPrintValue() Return the print name of the msgClass field.
static boolean	getMsgClassFlag(int fieldflag) Field flag accessor.
static java.lang.String	getMsgClassInvalidValue() Invalid value for msgClass.
static int	getMsgClassLengthMax() Maximum msgClass length is 80 characters
static int	getMsgClassLengthNorm() Normal msgClass length is 40 characters
java.lang.String	getMsgClassMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getMsgClassPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getMsgClassRange() Return the range specification for this field
java.lang.String	getMsgClassValidityCheck() 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
java.lang.String	getShortName() Returns the unqualified name of this message.
SandStructMessage	getStructMessage() Returns a new TestCondition instance
SandUpdateMessage	getUpdateMessage() Returns a new TestConditionUpdate 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
void	insertMatchInfo(int index, SandAttrVal value) Insert the specified element at the specified index.
boolean	isEquivalent(SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
boolean	matchInfoContains(SandAttrVal val) Returns true if matchInfo contains the specified value.
int	matchInfoIndexOf(SandAttrVal val) Return the index of the specified value in matchInfo, 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.
SandAttrVal	removeMatchInfo(int index) Remove the element at the specified index and return it.
boolean	removeMatchInfoValue(SandAttrVal value) Removes the given element from matchInfo.
void	setCommType(int commType) Mutator for commType
void	setMatchInfo(int index, SandAttrVal value) Set the value at the index specified.
void	setMatchInfo(java.lang.Object[] matchInfo) Generic mutator for matchInfo
void	setMatchInfo(SandAttrVal[] matchInfo) Mutator for matchInfo
void	setMsgClass(java.lang.Object msgClass) Generic mutator for msgClass
void	setMsgClass(java.lang.String msgClass) Mutator for msgClass
TestCondition	shallowCopy() Make a shallow copy of this TestCondition.
int	sizeofMatchInfo() Returns the size of matchInfo.
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

Constructor Detail

TestCondition

public TestCondition()

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.

getMsgClass

public java.lang.String getMsgClass()

Accessor for msgClass

setMsgClass

public void setMsgClass(java.lang.String msgClass)

Mutator for msgClass

setMsgClass

public void setMsgClass(java.lang.Object msgClass)

Generic mutator for msgClass

getMsgClassFlag

public static boolean getMsgClassFlag(int fieldflag)

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

getMsgClassLengthNorm

public static int getMsgClassLengthNorm()

Normal msgClass length is 40 characters

getMsgClassLengthMax

public static int getMsgClassLengthMax()

Maximum msgClass length is 80 characters

getMsgClassDefaultValue

public static java.lang.String getMsgClassDefaultValue()

Default value for msgClass. Returns ""

getMsgClassInvalidValue

public static java.lang.String getMsgClassInvalidValue()

Invalid value for msgClass. Returns null

getMsgClassPrintValue

public java.lang.String getMsgClassPrintValue()

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.

getMsgClassFieldPrintValue

public java.lang.String getMsgClassFieldPrintValue()

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

getMsgClassRange

public java.lang.String getMsgClassRange()

Return the range specification for this field

getMsgClassValidityCheck

public java.lang.String getMsgClassValidityCheck()

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.

getMsgClassMetatype

public java.lang.String getMsgClassMetatype()

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

getMatchInfo

public SandAttrVal[] getMatchInfo()

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

setMatchInfo

public void setMatchInfo(SandAttrVal[] matchInfo)

Mutator for matchInfo

setMatchInfo

public void setMatchInfo(java.lang.Object[] matchInfo)

Generic mutator for matchInfo

addMatchInfo

public void addMatchInfo(SandAttrVal element)

Appends a value to matchInfo

addMatchInfo

public void addMatchInfo(SandAttrVal[] elements)

Appends an array of values to matchInfo

getMatchInfo

public SandAttrVal getMatchInfo(int index)

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

setMatchInfo

public void setMatchInfo(int index,
                         SandAttrVal value)

Set the value at the index specified.

insertMatchInfo

public void insertMatchInfo(int index,
                            SandAttrVal 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.

removeMatchInfo

public SandAttrVal removeMatchInfo(int index)

Remove the element at the specified index and return it.

removeMatchInfoValue

public boolean removeMatchInfoValue(SandAttrVal value)

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

clearMatchInfo

public void clearMatchInfo()

Clears all values from matchInfo

matchInfoContains

public boolean matchInfoContains(SandAttrVal val)

Returns true if matchInfo contains the specified value.

matchInfoIndexOf

public int matchInfoIndexOf(SandAttrVal val)

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

sizeofMatchInfo

public int sizeofMatchInfo()

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

getMatchInfoFlag

public static boolean getMatchInfoFlag(int fieldflag)

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

getMatchInfoDefaultValue

public static SandAttrVal[] getMatchInfoDefaultValue()

Default value for matchInfo. Returns new SandAttrVal[0]

getMatchInfoElementInvalidValue

public static SandAttrVal getMatchInfoElementInvalidValue()

Invalid value for matchInfoelement. Returns null

getMatchInfoInvalidValue

public static SandAttrVal[] getMatchInfoInvalidValue()

Invalid value for matchInfo. Returns null

getMatchInfoPrintValue

public java.lang.String getMatchInfoPrintValue()

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.

getMatchInfoFieldPrintValue

public java.lang.String getMatchInfoFieldPrintValue()

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

getMatchInfoRange

public java.lang.String getMatchInfoRange()

Return the range specification for this field

getMatchInfoValidityCheck

public java.lang.String getMatchInfoValidityCheck()

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.

getMatchInfoMetatype

public java.lang.String getMatchInfoMetatype()

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

Specified by:

getUpdateMessage in interface SandMessage

getStructMessage

public SandStructMessage getStructMessage()

Returns a new TestCondition 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

getBaseMemoryUse

public int getBaseMemoryUse()

Return the base memory use for this object. This number is a minimum value for estimation purposes, see the comments in the SandStructMessage declaration for details.

Specified by:

getBaseMemoryUse 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

getLayoutXML

public java.lang.String getLayoutXML()

Return the fieldlayout XML or null if not defined.

Specified by:

getLayoutXML 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 cloneTestCondition

Specified by:

cloneMessage in interface SandInstanceMessage

cloneTestCondition

public TestCondition cloneTestCondition()

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

shallowCopy

public TestCondition shallowCopy()

Make a shallow copy of this TestCondition. Creates a new instance and then calls copyDataFrom.

copyDataFrom

public void copyDataFrom(TestCondition other,
                         boolean deepcopy)

Copy all the data from the specified instance. If the other instance is null then this method does nothing. If deepcopy is specified then contained structs are copied, otherwise not. The one field this does not copy is instanceWriteAccess, since you need the copied instance to be writeable.

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