org.sandev.ui.sandmessages
Class EmailAddress

java.lang.Object
  org.sandev.ui.structs.EmailAddressStruct
      org.sandev.ui.sandmessages.EmailAddress

All Implemented Interfaces:

org.sandev.basics.structs.SandInstanceMessage, org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable

public class EmailAddress
extends EmailAddressStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable

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

Field Summary

static int	VALIDITY_CONFIRMED Possible value for validity
static int	VALIDITY_INVALID Possible value for validity
static int	VALIDITY_NAMEGUESS Possible value for validity
static int	VALIDITY_VALID Possible value for validity

Fields inherited from class org.sandev.ui.structs.EmailAddressStruct

address, name, validity

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

EmailAddress()
Default constructor calls init.

Method Summary

EmailAddress	cloneEmailAddress() Make a deep copy of this EmailAddress.
org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls cloneEmailAddress
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(EmailAddress other, boolean deepcopy) Copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.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
org.sandev.basics.structs.SandAttrVal[]	fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
org.sandev.basics.structs.SandCollectionMessage	find(org.sandev.basics.structs.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.
org.sandev.basics.structs.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	getAddress() Accessor for address
static java.lang.String	getAddressDefaultValue() Default value for address.
java.lang.String	getAddressFieldPrintValue() Return the print name of the address field.
static boolean	getAddressFlag(int fieldflag) Field flag accessor.
static java.lang.String	getAddressInvalidValue() Invalid value for address.
static int	getAddressLengthMax() Maximum address length is 80 characters
static int	getAddressLengthNorm() Normal address length is 30 characters
java.lang.String	getAddressMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getAddressPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getAddressRange() Return the range specification for this field
java.lang.String	getAddressValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String[]	getAllFields() Return an array of all fields for this class.
int	getBaseMemoryUse() Return the base memory use for this object.
org.sandev.basics.structs.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[]	getDisplayValues() Return the values for the summary fields.
java.lang.String[]	getDisplayValues(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Return the values for the summary fields, including dereference expressions.
org.sandev.basics.structs.SandPersistMessage	getInstance(java.lang.String classname, long id) If this instance directly contains the specified instance, then find it and return it.
org.sandev.basics.structs.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	getName() Accessor for name
static java.lang.String	getNameDefaultValue() Default value for name.
java.lang.String	getNameFieldPrintValue() Return the print name of the name field.
static boolean	getNameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getNameInvalidValue() Invalid value for name.
static int	getNameLengthMax() Maximum name length is 80 characters
static int	getNameLengthNorm() Normal name length is 30 characters
java.lang.String	getNameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getNamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getNameRange() Return the range specification for this field
java.lang.String	getNameValidityCheck() 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.
org.sandev.basics.structs.SandQueryMessage	getQueryMessage() Returns null
java.lang.String	getShortName() Returns the unqualified name of this message.
org.sandev.basics.structs.SandStructMessage	getStructMessage() Returns a new EmailAddress instance
org.sandev.basics.structs.SandUpdateMessage	getUpdateMessage() Returns null
int	getValidity() Accessor for validity
static java.lang.String[]	getValidityActualVals() Return an array of the possible values for this field as Strings.
static int	getValidityDefaultValue() Default value for validity.
static java.lang.String	getValidityEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getValidityFieldPrintValue() Return the print name of the validity field.
static boolean	getValidityFlag(int fieldflag) Field flag accessor.
static int	getValidityInvalidValue() Invalid value for validity.
static java.lang.String[]	getValidityKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getValidityMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getValidityPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getValidityPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getValidityRange() Return the range specification for this field
java.lang.String	getValidityValidityCheck() 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, org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.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(org.sandev.basics.structs.SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, org.sandev.basics.util.IDLookup idlookup, org.sandev.basics.util.NameLookup namelookup, org.sandev.basics.util.AuthUser au) Validate the references as specified in the Resolvable interface.
void	setAddress(java.lang.Object address) Generic mutator for address
void	setAddress(java.lang.String address) Mutator for address
void	setName(java.lang.Object name) Generic mutator for name
void	setName(java.lang.String name) Mutator for name
void	setValidity(int validity) Mutator for validity
EmailAddress	shallowCopy() Make a shallow copy of this EmailAddress.
java.lang.String	toString() Return a string representation of this object.
static java.lang.String	validityActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	validityLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	validityLabelToValueStatic(java.lang.String label)
static java.lang.String	validityPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	validityPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	validityValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	validityValueToLabelStatic(int val)

Methods inherited from class java.lang.Object

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

Field Detail

VALIDITY_INVALID

public static final int VALIDITY_INVALID

Possible value for validity

See Also:

Constant Field Values

VALIDITY_NAMEGUESS

public static final int VALIDITY_NAMEGUESS

Possible value for validity

See Also:

Constant Field Values

VALIDITY_VALID

public static final int VALIDITY_VALID

Possible value for validity

See Also:

Constant Field Values

VALIDITY_CONFIRMED

public static final int VALIDITY_CONFIRMED

Possible value for validity

See Also:

Constant Field Values

Constructor Detail

EmailAddress

public EmailAddress()

Default constructor calls init.

Method Detail

getPrintname

public java.lang.String getPrintname()

Return the printname of the class

Specified by:

getPrintname in interface org.sandev.basics.structs.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 org.sandev.basics.structs.SandInstanceMessage

getAddress

public java.lang.String getAddress()

Accessor for address

setAddress

public void setAddress(java.lang.String address)

Mutator for address

setAddress

public void setAddress(java.lang.Object address)

Generic mutator for address

getAddressFlag

public static boolean getAddressFlag(int fieldflag)

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

getAddressLengthNorm

public static int getAddressLengthNorm()

Normal address length is 30 characters

getAddressLengthMax

public static int getAddressLengthMax()

Maximum address length is 80 characters

getAddressDefaultValue

public static java.lang.String getAddressDefaultValue()

Default value for address. Returns ""

getAddressInvalidValue

public static java.lang.String getAddressInvalidValue()

Invalid value for address. Returns "INVALID_ADDRESS"

getAddressPrintValue

public java.lang.String getAddressPrintValue()

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.

getAddressFieldPrintValue

public java.lang.String getAddressFieldPrintValue()

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

getAddressRange

public java.lang.String getAddressRange()

Return the range specification for this field

getAddressValidityCheck

public java.lang.String getAddressValidityCheck()

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.

getAddressMetatype

public java.lang.String getAddressMetatype()

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

getName

public java.lang.String getName()

Accessor for name

setName

public void setName(java.lang.String name)

Mutator for name

setName

public void setName(java.lang.Object name)

Generic mutator for name

getNameFlag

public static boolean getNameFlag(int fieldflag)

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

getNameLengthNorm

public static int getNameLengthNorm()

Normal name length is 30 characters

getNameLengthMax

public static int getNameLengthMax()

Maximum name length is 80 characters

getNameDefaultValue

public static java.lang.String getNameDefaultValue()

Default value for name. Returns ""

getNameInvalidValue

public static java.lang.String getNameInvalidValue()

Invalid value for name. Returns "INVALID_NAME"

getNamePrintValue

public java.lang.String getNamePrintValue()

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.

getNameFieldPrintValue

public java.lang.String getNameFieldPrintValue()

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

getNameRange

public java.lang.String getNameRange()

Return the range specification for this field

getNameValidityCheck

public java.lang.String getNameValidityCheck()

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.

getNameMetatype

public java.lang.String getNameMetatype()

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

getValidity

public int getValidity()

Accessor for validity

setValidity

public void setValidity(int validity)

Mutator for validity

validityValueToLabel

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

validityValueToLabelStatic

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

validityLabelToValue

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

validityLabelToValueStatic

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

getValidityPrintVals

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

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.

getValidityKeyVals

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

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.

getValidityActualVals

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

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

validityPrint2Key

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

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

validityPrint2Actual

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

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

validityActual2Print

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

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

getValidityEnumSummary

public static java.lang.String getValidityEnumSummary()

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

getValidityFlag

public static boolean getValidityFlag(int fieldflag)

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

getValidityDefaultValue

public static int getValidityDefaultValue()

Default value for validity. Returns VALIDITY_VALID

getValidityInvalidValue

public static int getValidityInvalidValue()

Invalid value for validity. Returns -1

getValidityPrintValue

public java.lang.String getValidityPrintValue()

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.

getValidityFieldPrintValue

public java.lang.String getValidityFieldPrintValue()

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

getValidityRange

public java.lang.String getValidityRange()

Return the range specification for this field

getValidityValidityCheck

public java.lang.String getValidityValidityCheck()

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.

getValidityMetatype

public java.lang.String getValidityMetatype()

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 org.sandev.basics.structs.SandMessage

getQueryMessage

public org.sandev.basics.structs.SandQueryMessage getQueryMessage()

Returns null

Specified by:

getQueryMessage in interface org.sandev.basics.structs.SandMessage

getCollectionMessage

public org.sandev.basics.structs.SandCollectionMessage getCollectionMessage()

Returns null

Specified by:

getCollectionMessage in interface org.sandev.basics.structs.SandMessage

getUpdateMessage

public org.sandev.basics.structs.SandUpdateMessage getUpdateMessage()

Returns null

Specified by:

getUpdateMessage in interface org.sandev.basics.structs.SandMessage

getStructMessage

public org.sandev.basics.structs.SandStructMessage getStructMessage()

Returns a new EmailAddress instance

Specified by:

getStructMessage in interface org.sandev.basics.structs.SandMessage

isEquivalent

public boolean isEquivalent(org.sandev.basics.structs.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 org.sandev.basics.structs.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 org.sandev.basics.structs.SandMessage

generalModifier

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

General mutator method. Specified by SandInstanceMessage interface.

Specified by:

generalModifier in interface org.sandev.basics.structs.SandInstanceMessage

Throws:

org.sandev.basics.structs.SandException

generalDereference

public org.sandev.basics.structs.SandAttrVal generalDereference(java.lang.String fieldspec)

General reference field accessor method. Specified by SandInstanceMessage interface.

Specified by:

generalDereference in interface org.sandev.basics.structs.SandInstanceMessage

generalAccessor

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

General field accessor method. Specified by SandInstanceMessage interface.

Specified by:

generalAccessor in interface org.sandev.basics.structs.SandInstanceMessage

getDisplayFields

public java.lang.String[] getDisplayFields()

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

Specified by:

getDisplayFields in interface org.sandev.basics.structs.SandInstanceMessage

getDisplayFieldsPrint

public java.lang.String[] getDisplayFieldsPrint()

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

Specified by:

getDisplayFieldsPrint in interface org.sandev.basics.structs.SandInstanceMessage

getLayoutXML

public java.lang.String getLayoutXML()

Return the fieldlayout XML or null if not defined.

Specified by:

getLayoutXML in interface org.sandev.basics.structs.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 org.sandev.basics.structs.SandInstanceMessage

getDisplayValues

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

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

Specified by:

getDisplayValues in interface org.sandev.basics.util.Resolvable

getValueForFieldName

public java.lang.String getValueForFieldName(java.lang.String fieldname,
                                             org.sandev.basics.util.IDLookup lookup,
                                             org.sandev.basics.util.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 org.sandev.basics.structs.SandInstanceMessage

getContainedMessageFields

public java.lang.String[] getContainedMessageFields()

Return an array of all contained message fields.

Specified by:

getContainedMessageFields in interface org.sandev.basics.structs.SandInstanceMessage

defaultField

public void defaultField(java.lang.String fieldname)

Set the specified field to its default value.

Specified by:

defaultField in interface org.sandev.basics.structs.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 org.sandev.basics.structs.SandInstanceMessage

cloneMessage

public org.sandev.basics.structs.SandInstanceMessage cloneMessage()

Calls cloneEmailAddress

Specified by:

cloneMessage in interface org.sandev.basics.structs.SandInstanceMessage

cloneEmailAddress

public EmailAddress cloneEmailAddress()

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

shallowCopy

public EmailAddress shallowCopy()

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

copyDataFrom

public void copyDataFrom(EmailAddress 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,
                           org.sandev.basics.structs.SandInstanceMessage other)

Copy the specified field from the given instance.

Specified by:

copyFieldValue in interface org.sandev.basics.structs.SandInstanceMessage

fieldValidate

public org.sandev.basics.structs.SandAttrVal[] fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields)

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

fieldValidate in interface org.sandev.basics.structs.SandInstanceMessage

fieldsValid

public boolean fieldsValid()

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

fieldsValid in interface org.sandev.basics.structs.SandInstanceMessage

referenceValidate

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

Validate the references as specified in the Resolvable interface.

Specified by:

referenceValidate in interface org.sandev.basics.util.Resolvable

Throws:

org.sandev.basics.structs.SandException

convertToSuperstructClass

public org.sandev.basics.structs.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 org.sandev.basics.structs.SandInstanceMessage

debugDump

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

Dump this instance into a debug printable string.

Specified by:

debugDump in interface org.sandev.basics.structs.SandInstanceMessage

getDisplayID

public java.lang.String getDisplayID()

Return the displayID for this message instance

Specified by:

getDisplayID in interface org.sandev.basics.structs.SandInstanceMessage

getInstance

public org.sandev.basics.structs.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 org.sandev.basics.structs.SandStructMessage

getInstance

public org.sandev.basics.structs.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 org.sandev.basics.structs.SandStructMessage

find

public org.sandev.basics.structs.SandCollectionMessage find(org.sandev.basics.structs.SandQueryMessage sqm)

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

Specified by:

find in interface org.sandev.basics.structs.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