org.sandev.basics.sandmessages
Class UIFormQuery

java.lang.Object
  extended by org.sandev.basics.structs.UIFormQueryStruct
      extended by org.sandev.basics.sandmessages.UIFormQuery
All Implemented Interfaces:
SandInstanceMessage, SandMessage, SandStructMessage, Resolvable

public class UIFormQuery
extends UIFormQueryStruct
implements SandStructMessage, Resolvable

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


Field Summary
 
Fields inherited from class org.sandev.basics.structs.UIFormQueryStruct
displayText, selectionIndex, selectionOptions
 
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
UIFormQuery()
          Default constructor calls init.
 
Method Summary
 void addSelectionOptions(java.lang.String element)
          Appends a value to selectionOptions
 void addSelectionOptions(java.lang.String[] elements)
          Appends an array of values to selectionOptions
 void clearSelectionOptions()
          Clears all values from selectionOptions
 SandInstanceMessage cloneMessage()
          Calls cloneUIFormQuery
 UIFormQuery cloneUIFormQuery()
          Make a deep copy of this UIFormQuery.
 SandInstanceMessage convertToSuperstructClass()
          Return a new instance of the message associated with the superstruct of this instance.
 void copyDataFrom(UIFormQuery 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
 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 getDisplayText()
          Accessor for displayText
static java.lang.String getDisplayTextDefaultValue()
          Default value for displayText.
 java.lang.String getDisplayTextFieldPrintValue()
          Return the print name of the displayText field.
static boolean getDisplayTextFlag(int fieldflag)
          Field flag accessor.
static java.lang.String getDisplayTextInvalidValue()
          Invalid value for displayText.
static int getDisplayTextLengthMax()
          Maximum displayText length is 4096 characters
static int getDisplayTextLengthNorm()
          Normal displayText length is 80 characters
 java.lang.String getDisplayTextMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getDisplayTextPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getDisplayTextRange()
          Return the range specification for this field
 java.lang.String getDisplayTextValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 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.
 java.lang.String getPrintname()
          Return the printname of the class
 java.lang.String getPrintnameForField(java.lang.String fieldname)
          Given a fieldname, return its declared printname if declared.
 SandQueryMessage getQueryMessage()
          Returns null
 int getSelectionIndex()
          Accessor for selectionIndex
static int getSelectionIndexDefaultValue()
          Default value for selectionIndex.
 java.lang.String getSelectionIndexFieldPrintValue()
          Return the print name of the selectionIndex field.
static boolean getSelectionIndexFlag(int fieldflag)
          Field flag accessor.
static int getSelectionIndexInvalidValue()
          Invalid value for selectionIndex.
 java.lang.String getSelectionIndexMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getSelectionIndexPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getSelectionIndexRange()
          Return the range specification for this field
 java.lang.String getSelectionIndexValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String[] getSelectionOptions()
          Accessor for selectionOptions.
 java.lang.String getSelectionOptions(int index)
          Returns the element at the specified index.
static java.lang.String[] getSelectionOptionsDefaultValue()
          Default value for selectionOptions.
static java.lang.String getSelectionOptionsElementInvalidValue()
          Invalid value for selectionOptionselement.
 java.lang.String getSelectionOptionsFieldPrintValue()
          Return the print name of the selectionOptions field.
static boolean getSelectionOptionsFlag(int fieldflag)
          Field flag accessor.
static java.lang.String[] getSelectionOptionsInvalidValue()
          Invalid value for selectionOptions.
static int getSelectionOptionsLengthMax()
          Maximum selectionOptions length is 70 characters
static int getSelectionOptionsLengthNorm()
          Normal selectionOptions length is 30 characters
 java.lang.String getSelectionOptionsMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getSelectionOptionsPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getSelectionOptionsRange()
          Return the range specification for this field
 java.lang.String getSelectionOptionsValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getShortName()
          Returns the unqualified name of this message.
 SandStructMessage getStructMessage()
          Returns a new UIFormQuery instance
 SandUpdateMessage getUpdateMessage()
          Returns null
 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 insertSelectionOptions(int index, java.lang.String 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.
 java.lang.String removeSelectionOptions(int index)
          Remove the element at the specified index and return it.
 boolean removeSelectionOptionsValue(java.lang.String value)
          Removes the given element from selectionOptions.
 boolean selectionOptionsContains(java.lang.String val)
          Returns true if selectionOptions contains the specified value.
 int selectionOptionsIndexOf(java.lang.String val)
          Return the index of the specified value in selectionOptions, or -1 if not found.
 void setDisplayText(java.lang.Object displayText)
          Generic mutator for displayText
 void setDisplayText(java.lang.String displayText)
          Mutator for displayText
 void setSelectionIndex(int selectionIndex)
          Mutator for selectionIndex
 void setSelectionOptions(int index, java.lang.String value)
          Set the value at the index specified.
 void setSelectionOptions(java.lang.String[] selectionOptions)
          Mutator for selectionOptions
 UIFormQuery shallowCopy()
          Make a shallow copy of this UIFormQuery.
 int sizeofSelectionOptions()
          Returns the size of selectionOptions.
 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

UIFormQuery

public UIFormQuery()
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

getDisplayText

public java.lang.String getDisplayText()
Accessor for displayText


setDisplayText

public void setDisplayText(java.lang.String displayText)
Mutator for displayText


setDisplayText

public void setDisplayText(java.lang.Object displayText)
Generic mutator for displayText


getDisplayTextFlag

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


getDisplayTextLengthNorm

public static int getDisplayTextLengthNorm()
Normal displayText length is 80 characters


getDisplayTextLengthMax

public static int getDisplayTextLengthMax()
Maximum displayText length is 4096 characters


getDisplayTextDefaultValue

public static java.lang.String getDisplayTextDefaultValue()
Default value for displayText. Returns "please choose a value"


getDisplayTextInvalidValue

public static java.lang.String getDisplayTextInvalidValue()
Invalid value for displayText. Returns null


getDisplayTextPrintValue

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


getDisplayTextFieldPrintValue

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


getDisplayTextRange

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


getDisplayTextValidityCheck

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


getDisplayTextMetatype

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


getSelectionOptions

public java.lang.String[] getSelectionOptions()
Accessor for selectionOptions. The returned value may or may not be the actual data member. Always write back a changed array using setSelectionOptions.


setSelectionOptions

public void setSelectionOptions(java.lang.String[] selectionOptions)
Mutator for selectionOptions


addSelectionOptions

public void addSelectionOptions(java.lang.String element)
Appends a value to selectionOptions


addSelectionOptions

public void addSelectionOptions(java.lang.String[] elements)
Appends an array of values to selectionOptions


getSelectionOptions

public java.lang.String getSelectionOptions(int index)
Returns the element at the specified index. Returns null if selectionOptions is null or smaller than index.


setSelectionOptions

public void setSelectionOptions(int index,
                                java.lang.String value)
Set the value at the index specified.


insertSelectionOptions

public void insertSelectionOptions(int index,
                                   java.lang.String 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.


removeSelectionOptions

public java.lang.String removeSelectionOptions(int index)
Remove the element at the specified index and return it.


removeSelectionOptionsValue

public boolean removeSelectionOptionsValue(java.lang.String value)
Removes the given element from selectionOptions. Returns true if the element was found.


clearSelectionOptions

public void clearSelectionOptions()
Clears all values from selectionOptions


selectionOptionsContains

public boolean selectionOptionsContains(java.lang.String val)
Returns true if selectionOptions contains the specified value.


selectionOptionsIndexOf

public int selectionOptionsIndexOf(java.lang.String val)
Return the index of the specified value in selectionOptions, or -1 if not found.


sizeofSelectionOptions

public int sizeofSelectionOptions()
Returns the size of selectionOptions. Returns -1 if selectionOptions is null.


getSelectionOptionsFlag

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


getSelectionOptionsLengthNorm

public static int getSelectionOptionsLengthNorm()
Normal selectionOptions length is 30 characters


getSelectionOptionsLengthMax

public static int getSelectionOptionsLengthMax()
Maximum selectionOptions length is 70 characters


getSelectionOptionsDefaultValue

public static java.lang.String[] getSelectionOptionsDefaultValue()
Default value for selectionOptions. Returns new String[0]


getSelectionOptionsElementInvalidValue

public static java.lang.String getSelectionOptionsElementInvalidValue()
Invalid value for selectionOptionselement. Returns null


getSelectionOptionsInvalidValue

public static java.lang.String[] getSelectionOptionsInvalidValue()
Invalid value for selectionOptions. Returns null


getSelectionOptionsPrintValue

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


getSelectionOptionsFieldPrintValue

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


getSelectionOptionsRange

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


getSelectionOptionsValidityCheck

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


getSelectionOptionsMetatype

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


getSelectionIndex

public int getSelectionIndex()
Accessor for selectionIndex


setSelectionIndex

public void setSelectionIndex(int selectionIndex)
Mutator for selectionIndex


getSelectionIndexFlag

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


getSelectionIndexDefaultValue

public static int getSelectionIndexDefaultValue()
Default value for selectionIndex. Returns -1


getSelectionIndexInvalidValue

public static int getSelectionIndexInvalidValue()
Invalid value for selectionIndex. Returns Integer.MIN_VALUE


getSelectionIndexPrintValue

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


getSelectionIndexFieldPrintValue

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


getSelectionIndexRange

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


getSelectionIndexValidityCheck

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


getSelectionIndexMetatype

public java.lang.String getSelectionIndexMetatype()
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 UIFormQuery 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 cloneUIFormQuery

Specified by:
cloneMessage in interface SandInstanceMessage

cloneUIFormQuery

public UIFormQuery cloneUIFormQuery()
Make a deep copy of this UIFormQuery. Creates a new instance and then calls copyDataFrom.


shallowCopy

public UIFormQuery shallowCopy()
Make a shallow copy of this UIFormQuery. Creates a new instance and then calls copyDataFrom.


copyDataFrom

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