org.sandev.basics.sandmessages
Class UIDisplayDirective

java.lang.Object
  org.sandev.basics.structs.UIDisplayDirectiveStruct
      org.sandev.basics.sandmessages.UIDisplayDirective

All Implemented Interfaces:

SandInstanceMessage, SandMessage, SandStructMessage, Resolvable

public class UIDisplayDirective
extends UIDisplayDirectiveStruct
implements SandStructMessage, Resolvable

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

Field Summary

static int	DIRECTIVE_COLLAPSE Possible value for directive
static int	DIRECTIVE_EXPAND Possible value for directive
static int	DIRECTIVE_NONE Possible value for directive
static int	DIRECTIVE_RESERVEMAX Possible value for directive

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

className, directive, fieldName, instanceID

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

UIDisplayDirective()
Default constructor calls init.

Method Summary

SandInstanceMessage	cloneMessage() Calls cloneUIDisplayDirective
UIDisplayDirective	cloneUIDisplayDirective() Make a deep copy of this UIDisplayDirective.
SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(UIDisplayDirective 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.
static java.lang.String	directiveActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	directiveLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	directiveLabelToValueStatic(java.lang.String label)
static java.lang.String	directivePrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	directivePrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	directiveValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	directiveValueToLabelStatic(int val)
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.
java.lang.String	getClassName() Accessor for className
static java.lang.String	getClassNameDefaultValue() Default value for className.
java.lang.String	getClassNameFieldPrintValue() Return the print name of the className field.
static boolean	getClassNameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getClassNameInvalidValue() Invalid value for className.
static int	getClassNameLengthMax() Maximum className length is 70 characters
static int	getClassNameLengthNorm() Normal className length is 30 characters
java.lang.String	getClassNameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getClassNamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getClassNameRange() Return the range specification for this field
java.lang.String	getClassNameValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandCollectionMessage	getCollectionMessage() Returns null
java.lang.String[]	getContainedMessageFields() Return an array of all contained message fields.
int	getDirective() Accessor for directive
static java.lang.String[]	getDirectiveActualVals() Return an array of the possible values for this field as Strings.
static int	getDirectiveDefaultValue() Default value for directive.
static java.lang.String	getDirectiveEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getDirectiveFieldPrintValue() Return the print name of the directive field.
static boolean	getDirectiveFlag(int fieldflag) Field flag accessor.
static int	getDirectiveInvalidValue() Invalid value for directive.
static java.lang.String[]	getDirectiveKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getDirectiveMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getDirectivePrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getDirectivePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDirectiveRange() Return the range specification for this field
java.lang.String	getDirectiveValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
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 70 characters
static int	getFieldNameLengthNorm() Normal fieldName length is 30 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	getInstanceID() Accessor for instanceID
static java.lang.String	getInstanceIDDefaultValue() Default value for instanceID.
java.lang.String	getInstanceIDFieldPrintValue() Return the print name of the instanceID field.
static boolean	getInstanceIDFlag(int fieldflag) Field flag accessor.
static java.lang.String	getInstanceIDInvalidValue() Invalid value for instanceID.
static int	getInstanceIDLengthMax() Maximum instanceID length is 70 characters
static int	getInstanceIDLengthNorm() Normal instanceID length is 30 characters
java.lang.String	getInstanceIDMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getInstanceIDPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getInstanceIDRange() Return the range specification for this field
java.lang.String	getInstanceIDValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
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
java.lang.String	getShortName() Returns the unqualified name of this message.
SandStructMessage	getStructMessage() Returns a new UIDisplayDirective 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
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	setClassName(java.lang.Object className) Generic mutator for className
void	setClassName(java.lang.String className) Mutator for className
void	setDirective(int directive) Mutator for directive
void	setFieldName(java.lang.Object fieldName) Generic mutator for fieldName
void	setFieldName(java.lang.String fieldName) Mutator for fieldName
void	setInstanceID(java.lang.Object instanceID) Generic mutator for instanceID
void	setInstanceID(java.lang.String instanceID) Mutator for instanceID
UIDisplayDirective	shallowCopy() Make a shallow copy of this UIDisplayDirective.
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

DIRECTIVE_NONE

public static final int DIRECTIVE_NONE

Possible value for directive

See Also:

Constant Field Values

DIRECTIVE_COLLAPSE

public static final int DIRECTIVE_COLLAPSE

Possible value for directive

See Also:

Constant Field Values

DIRECTIVE_EXPAND

public static final int DIRECTIVE_EXPAND

Possible value for directive

See Also:

Constant Field Values

DIRECTIVE_RESERVEMAX

public static final int DIRECTIVE_RESERVEMAX

Possible value for directive

See Also:

Constant Field Values

Constructor Detail

UIDisplayDirective

public UIDisplayDirective()

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

getClassName

public java.lang.String getClassName()

Accessor for className

setClassName

public void setClassName(java.lang.String className)

Mutator for className

setClassName

public void setClassName(java.lang.Object className)

Generic mutator for className

getClassNameFlag

public static boolean getClassNameFlag(int fieldflag)

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

getClassNameLengthNorm

public static int getClassNameLengthNorm()

Normal className length is 30 characters

getClassNameLengthMax

public static int getClassNameLengthMax()

Maximum className length is 70 characters

getClassNameDefaultValue

public static java.lang.String getClassNameDefaultValue()

Default value for className. Returns ""

getClassNameInvalidValue

public static java.lang.String getClassNameInvalidValue()

Invalid value for className. Returns null

getClassNamePrintValue

public java.lang.String getClassNamePrintValue()

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.

getClassNameFieldPrintValue

public java.lang.String getClassNameFieldPrintValue()

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

getClassNameRange

public java.lang.String getClassNameRange()

Return the range specification for this field

getClassNameValidityCheck

public java.lang.String getClassNameValidityCheck()

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.

getClassNameMetatype

public java.lang.String getClassNameMetatype()

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

getInstanceID

public java.lang.String getInstanceID()

Accessor for instanceID

setInstanceID

public void setInstanceID(java.lang.String instanceID)

Mutator for instanceID

setInstanceID

public void setInstanceID(java.lang.Object instanceID)

Generic mutator for instanceID

getInstanceIDFlag

public static boolean getInstanceIDFlag(int fieldflag)

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

getInstanceIDLengthNorm

public static int getInstanceIDLengthNorm()

Normal instanceID length is 30 characters

getInstanceIDLengthMax

public static int getInstanceIDLengthMax()

Maximum instanceID length is 70 characters

getInstanceIDDefaultValue

public static java.lang.String getInstanceIDDefaultValue()

Default value for instanceID. Returns ""

getInstanceIDInvalidValue

public static java.lang.String getInstanceIDInvalidValue()

Invalid value for instanceID. Returns null

getInstanceIDPrintValue

public java.lang.String getInstanceIDPrintValue()

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.

getInstanceIDFieldPrintValue

public java.lang.String getInstanceIDFieldPrintValue()

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

getInstanceIDRange

public java.lang.String getInstanceIDRange()

Return the range specification for this field

getInstanceIDValidityCheck

public java.lang.String getInstanceIDValidityCheck()

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.

getInstanceIDMetatype

public java.lang.String getInstanceIDMetatype()

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 30 characters

getFieldNameLengthMax

public static int getFieldNameLengthMax()

Maximum fieldName length is 70 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 null

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.

getDirective

public int getDirective()

Accessor for directive

setDirective

public void setDirective(int directive)

Mutator for directive

directiveValueToLabel

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

directiveValueToLabelStatic

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

directiveLabelToValue

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

directiveLabelToValueStatic

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

getDirectivePrintVals

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

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.

getDirectiveKeyVals

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

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.

getDirectiveActualVals

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

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

directivePrint2Key

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

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

directivePrint2Actual

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

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

directiveActual2Print

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

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

getDirectiveEnumSummary

public static java.lang.String getDirectiveEnumSummary()

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

getDirectiveFlag

public static boolean getDirectiveFlag(int fieldflag)

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

getDirectiveDefaultValue

public static int getDirectiveDefaultValue()

Default value for directive. Returns 0

getDirectiveInvalidValue

public static int getDirectiveInvalidValue()

Invalid value for directive. Returns -1

getDirectivePrintValue

public java.lang.String getDirectivePrintValue()

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.

getDirectiveFieldPrintValue

public java.lang.String getDirectiveFieldPrintValue()

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

getDirectiveRange

public java.lang.String getDirectiveRange()

Return the range specification for this field

getDirectiveValidityCheck

public java.lang.String getDirectiveValidityCheck()

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.

getDirectiveMetatype

public java.lang.String getDirectiveMetatype()

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 UIDisplayDirective 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 cloneUIDisplayDirective

Specified by:

cloneMessage in interface SandInstanceMessage

cloneUIDisplayDirective

public UIDisplayDirective cloneUIDisplayDirective()

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

shallowCopy

public UIDisplayDirective shallowCopy()

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

copyDataFrom

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