org.sandev.basics.sandmessages
Class ErrorInfo

java.lang.Object
  org.sandev.basics.structs.ErrorInfoStruct
      org.sandev.basics.sandmessages.ErrorInfo

All Implemented Interfaces:

SandInstanceMessage, SandMessage, SandStructMessage, Resolvable

public class ErrorInfo
extends ErrorInfoStruct
implements SandStructMessage, Resolvable

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

Field Summary

static int	SEVERITY_ERROR Possible value for severity
static int	SEVERITY_INFO Possible value for severity
static int	SEVERITY_WARNING Possible value for severity

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

code, fieldname, severity, text

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

ErrorInfo()
Default constructor calls init.

Method Summary

ErrorInfo	cloneErrorInfo() Make a deep copy of this ErrorInfo.
SandInstanceMessage	cloneMessage() Calls cloneErrorInfo
SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(ErrorInfo other) Deep copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, SandInstanceMessage other) Copy the specified field from the given instance.
java.lang.String	debugDump(java.lang.String prefix) Dump this instance into a debug printable string.
void	defaultField(java.lang.String fieldname) Set the specified field to its default value.
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
boolean	fieldsValid() Validate the fields as specified in the SandInstanceMessage interface
SandAttrVal[]	fieldValidate(SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
SandCollectionMessage	find(SandQueryMessage sqm) Return a matching collection of all directly contained instances matching the given query.
java.lang.Object	generalAccessor(java.lang.String fieldspec) General field accessor method.
SandAttrVal	generalDereference(java.lang.String fieldspec) General reference field accessor method.
void	generalModifier(int action, java.lang.String field, int index, java.lang.Object val) General mutator method.
java.lang.String[]	getAllFields() Return an array of all fields for this class.
java.lang.String	getCode() Accessor for code
static java.lang.String	getCodeDefaultValue() Default value for code.
java.lang.String	getCodeFieldPrintValue() Return the print name of the code field.
static boolean	getCodeFlag(int fieldflag) Field flag accessor.
static java.lang.String	getCodeInvalidValue() Invalid value for code.
static int	getCodeLengthMax() Maximum code length is 80 characters
static int	getCodeLengthNorm() Normal code length is 10 characters
java.lang.String	getCodeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getCodePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getCodeRange() Return the range specification for this field
java.lang.String	getCodeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandCollectionMessage	getCollectionMessage() Returns a new ErrorInfoCollection instance
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.
java.lang.String	getFieldname() Accessor for fieldname
static java.lang.String	getFieldnameDefaultValue() Default value for fieldname.
java.lang.String	getFieldnameFieldPrintValue() Return the print name of the fieldname field.
static boolean	getFieldnameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getFieldnameInvalidValue() Invalid value for fieldname.
static int	getFieldnameLengthMax() Maximum fieldname length is 60 characters
static int	getFieldnameLengthNorm() Normal fieldname length is 15 characters
java.lang.String	getFieldnameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getFieldnamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getFieldnameRange() Return the range specification for this field
java.lang.String	getFieldnameValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandPersistMessage	getInstance(java.lang.String classname, long id) If this instance directly contains the specified instance, then find it and return it.
SandInstanceMessage	getInstance(java.lang.String classname, java.lang.String fieldname, java.lang.String value) If this instance directly contains the specified instance, then find it and return it.
java.lang.String	getPrintname() Return the printname of the class
java.lang.String	getPrintnameForField(java.lang.String fieldname) Given a fieldname, return its declared printname if declared.
SandQueryMessage	getQueryMessage() Returns null
int	getSeverity() Accessor for severity
static java.lang.String[]	getSeverityActualVals() Return an array of the possible values for this field as Strings.
static int	getSeverityDefaultValue() Default value for severity.
static java.lang.String	getSeverityEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getSeverityFieldPrintValue() Return the print name of the severity field.
static boolean	getSeverityFlag(int fieldflag) Field flag accessor.
static int	getSeverityInvalidValue() Invalid value for severity.
static java.lang.String[]	getSeverityKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getSeverityMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getSeverityPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getSeverityPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSeverityRange() Return the range specification for this field
java.lang.String	getSeverityValidityCheck() 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 ErrorInfo instance
java.lang.String	getText() Accessor for text
static java.lang.String	getTextDefaultValue() Default value for text.
java.lang.String	getTextFieldPrintValue() Return the print name of the text field.
static boolean	getTextFlag(int fieldflag) Field flag accessor.
static java.lang.String	getTextInvalidValue() Invalid value for text.
static int	getTextLengthMax() Maximum text length is 255 characters
static int	getTextLengthNorm() Normal text length is 60 characters
java.lang.String	getTextMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getTextPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getTextRange() Return the range specification for this field
java.lang.String	getTextValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
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
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.
void	setCode(java.lang.Object code) Generic mutator for code
void	setCode(java.lang.String code) Mutator for code
void	setFieldname(java.lang.Object fieldname) Generic mutator for fieldname
void	setFieldname(java.lang.String fieldname) Mutator for fieldname
void	setSeverity(int severity) Mutator for severity
void	setText(java.lang.Object text) Generic mutator for text
void	setText(java.lang.String text) Mutator for text
static java.lang.String	severityActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	severityLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	severityLabelToValueStatic(java.lang.String label)
static java.lang.String	severityPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	severityPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	severityValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	severityValueToLabelStatic(int val)
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

SEVERITY_INFO

public static final int SEVERITY_INFO

Possible value for severity

See Also:

Constant Field Values

SEVERITY_WARNING

public static final int SEVERITY_WARNING

Possible value for severity

See Also:

Constant Field Values

SEVERITY_ERROR

public static final int SEVERITY_ERROR

Possible value for severity

See Also:

Constant Field Values

Constructor Detail

ErrorInfo

public ErrorInfo()

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

getSeverity

public int getSeverity()

Accessor for severity

setSeverity

public void setSeverity(int severity)

Mutator for severity

severityValueToLabel

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

severityValueToLabelStatic

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

severityLabelToValue

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

severityLabelToValueStatic

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

getSeverityPrintVals

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

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.

getSeverityKeyVals

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

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.

getSeverityActualVals

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

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

severityPrint2Key

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

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

severityPrint2Actual

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

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

severityActual2Print

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

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

getSeverityEnumSummary

public static java.lang.String getSeverityEnumSummary()

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

getSeverityFlag

public static boolean getSeverityFlag(int fieldflag)

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

getSeverityDefaultValue

public static int getSeverityDefaultValue()

Default value for severity. Returns SEVERITY_ERROR

getSeverityInvalidValue

public static int getSeverityInvalidValue()

Invalid value for severity. Returns -1

getSeverityPrintValue

public java.lang.String getSeverityPrintValue()

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.

getSeverityFieldPrintValue

public java.lang.String getSeverityFieldPrintValue()

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

getSeverityRange

public java.lang.String getSeverityRange()

Return the range specification for this field

getSeverityValidityCheck

public java.lang.String getSeverityValidityCheck()

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.

getSeverityMetatype

public java.lang.String getSeverityMetatype()

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

getFieldname

public java.lang.String getFieldname()

Accessor for fieldname

setFieldname

public void setFieldname(java.lang.String fieldname)

Mutator for fieldname

setFieldname

public void setFieldname(java.lang.Object fieldname)

Generic mutator for fieldname

getFieldnameFlag

public static boolean getFieldnameFlag(int fieldflag)

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

getFieldnameLengthNorm

public static int getFieldnameLengthNorm()

Normal fieldname length is 15 characters

getFieldnameLengthMax

public static int getFieldnameLengthMax()

Maximum fieldname length is 60 characters

getFieldnameDefaultValue

public static java.lang.String getFieldnameDefaultValue()

Default value for fieldname. Returns ""

getFieldnameInvalidValue

public static java.lang.String getFieldnameInvalidValue()

Invalid value for fieldname. Returns "INVALID_FIELDNAME"

getFieldnamePrintValue

public java.lang.String getFieldnamePrintValue()

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.

getFieldnameFieldPrintValue

public java.lang.String getFieldnameFieldPrintValue()

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

getFieldnameRange

public java.lang.String getFieldnameRange()

Return the range specification for this field

getFieldnameValidityCheck

public java.lang.String getFieldnameValidityCheck()

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.

getFieldnameMetatype

public java.lang.String getFieldnameMetatype()

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

getCode

public java.lang.String getCode()

Accessor for code

setCode

public void setCode(java.lang.String code)

Mutator for code

setCode

public void setCode(java.lang.Object code)

Generic mutator for code

getCodeFlag

public static boolean getCodeFlag(int fieldflag)

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

getCodeLengthNorm

public static int getCodeLengthNorm()

Normal code length is 10 characters

getCodeLengthMax

public static int getCodeLengthMax()

Maximum code length is 80 characters

getCodeDefaultValue

public static java.lang.String getCodeDefaultValue()

Default value for code. Returns ""

getCodeInvalidValue

public static java.lang.String getCodeInvalidValue()

Invalid value for code. Returns "INVALID_CODE"

getCodePrintValue

public java.lang.String getCodePrintValue()

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.

getCodeFieldPrintValue

public java.lang.String getCodeFieldPrintValue()

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

getCodeRange

public java.lang.String getCodeRange()

Return the range specification for this field

getCodeValidityCheck

public java.lang.String getCodeValidityCheck()

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.

getCodeMetatype

public java.lang.String getCodeMetatype()

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

getText

public java.lang.String getText()

Accessor for text

setText

public void setText(java.lang.String text)

Mutator for text

setText

public void setText(java.lang.Object text)

Generic mutator for text

getTextFlag

public static boolean getTextFlag(int fieldflag)

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

getTextLengthNorm

public static int getTextLengthNorm()

Normal text length is 60 characters

getTextLengthMax

public static int getTextLengthMax()

Maximum text length is 255 characters

getTextDefaultValue

public static java.lang.String getTextDefaultValue()

Default value for text. Returns ""

getTextInvalidValue

public static java.lang.String getTextInvalidValue()

Invalid value for text. Returns "INVALID_TEXT"

getTextPrintValue

public java.lang.String getTextPrintValue()

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.

getTextFieldPrintValue

public java.lang.String getTextFieldPrintValue()

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

getTextRange

public java.lang.String getTextRange()

Return the range specification for this field

getTextValidityCheck

public java.lang.String getTextValidityCheck()

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.

getTextMetatype

public java.lang.String getTextMetatype()

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 a new ErrorInfoCollection instance

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

Specified by:

getStructMessage in interface SandMessage

isEquivalent

public boolean isEquivalent(SandMessage sm)

Declared field equivalence check as specified by the SandMessage interface. String values are trimmed before comparison because conversions may occasionally result in trailing whitespace, which should not cause equivalence comparisons to fail. Comparisons are case insensitive since that corresponds to what most people expect, and how most databases work.

When comparing arrays, it is possible that the array elements may have been set to null as part of authorization filtering or similar unusual circumstances. A null array element is only equivalent to another null array element.

Specified by:

isEquivalent in interface SandMessage

generalModifier

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

General mutator method. Specified by SandInstanceMessage interface.

Specified by:

generalModifier in interface SandInstanceMessage

Throws:

SandException

generalDereference

public SandAttrVal generalDereference(java.lang.String fieldspec)

General reference field accessor method. Specified by SandInstanceMessage interface.

Specified by:

generalDereference in interface SandInstanceMessage

generalAccessor

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

General field accessor method. Specified by SandInstanceMessage interface.

Specified by:

generalAccessor in interface SandInstanceMessage

getDisplayFields

public java.lang.String[] getDisplayFields()

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

Specified by:

getDisplayFields in interface SandInstanceMessage

getDisplayFieldsPrint

public java.lang.String[] getDisplayFieldsPrint()

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

Specified by:

getDisplayFieldsPrint in interface SandInstanceMessage

getDisplayValues

public java.lang.String[] getDisplayValues()

Return the values for the summary fields. The standard String representation of each value is returned. For Dates, the default DateFormat output is used. For enums, the print value is used. These can be further transformed as needed.

Specified by:

getDisplayValues in interface SandInstanceMessage

getDisplayValues

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

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

Specified by:

getDisplayValues in interface Resolvable

getValueForFieldName

public java.lang.String getValueForFieldName(java.lang.String fieldname,
                                             IDLookup lookup,
                                             AuthUser user,
                                             java.lang.String defaultVal)

Returns the print representation of the value of the specified field, or the given default value if innaccessible. A field value may be innaccessible due to authorization, null reference, or other call failure.

getAllFields

public java.lang.String[] getAllFields()

Return an array of all fields for this class.

Specified by:

getAllFields in interface SandInstanceMessage

getContainedMessageFields

public java.lang.String[] getContainedMessageFields()

Return an array of all contained message fields.

Specified by:

getContainedMessageFields in interface SandInstanceMessage

defaultField

public void defaultField(java.lang.String fieldname)

Set the specified field to its default value.

Specified by:

defaultField in interface SandInstanceMessage

getPrintnameForField

public java.lang.String getPrintnameForField(java.lang.String fieldname)

Given a fieldname, return its declared printname if declared. If no printname was declared then this returns the field name.

Specified by:

getPrintnameForField in interface SandInstanceMessage

cloneMessage

public SandInstanceMessage cloneMessage()

Calls cloneErrorInfo

Specified by:

cloneMessage in interface SandInstanceMessage

cloneErrorInfo

public ErrorInfo cloneErrorInfo()

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

copyDataFrom

public void copyDataFrom(ErrorInfo other)

Deep copy all the data from the specified instance. If the other instance is null then this method does nothing.

copyFieldValue

public void copyFieldValue(java.lang.String fieldName,
                           SandInstanceMessage other)

Copy the specified field from the given instance.

Specified by:

copyFieldValue in interface SandInstanceMessage

fieldValidate

public SandAttrVal[] fieldValidate(SandAttrVal[] checkFields)

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

fieldValidate in interface SandInstanceMessage

fieldsValid

public boolean fieldsValid()

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

fieldsValid in interface SandInstanceMessage

referenceValidate

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

Validate the references as specified in the Resolvable interface.

Specified by:

referenceValidate in interface Resolvable

Throws:

SandException

convertToSuperstructClass

public SandInstanceMessage convertToSuperstructClass()

Return a new instance of the message associated with the superstruct of this instance. Return null if the source struct for this message does not extend another struct.

Specified by:

convertToSuperstructClass in interface SandInstanceMessage

debugDump

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

Dump this instance into a debug printable string.

Specified by:

debugDump in interface SandInstanceMessage

getDisplayID

public java.lang.String getDisplayID()

Return the displayID for this message instance

Specified by:

getDisplayID in interface SandInstanceMessage

getInstance

public SandPersistMessage getInstance(java.lang.String classname,
                                      long id)

If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

Specified by:

getInstance in interface SandStructMessage

getInstance

public SandInstanceMessage getInstance(java.lang.String classname,
                                       java.lang.String fieldname,
                                       java.lang.String value)

If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

Specified by:

getInstance in interface SandStructMessage

find

public SandCollectionMessage find(SandQueryMessage sqm)

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

Specified by:

find in interface SandStructMessage

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object