org.sandev.basics.sandmessages
Class IODeclSubscribe

java.lang.Object
  org.sandev.basics.structs.IODeclBaseStruct
      org.sandev.basics.structs.IODeclSubscribeStruct
          org.sandev.basics.sandmessages.IODeclSubscribe

All Implemented Interfaces:

IODeclBaseInterface, SandInstanceMessage, SandMessage, SandStructMessage, Resolvable

public class IODeclSubscribe
extends IODeclSubscribeStruct
implements SandStructMessage, Resolvable, IODeclBaseInterface

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

Field Summary

static int	MODE_DIRECT Possible value for mode
static int	MODE_INVALID Possible value for mode
static int	MODE_SECURE Possible value for mode
static int	OPTIMIZE_IF_POSSIBLE Possible value for optimize
static int	OPTIMIZE_NEVER Possible value for optimize

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

target

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

gateway, mode, optimize

Constructor Summary

IODeclSubscribe()
Default constructor calls init.

Method Summary

IODeclSubscribe	cloneIODeclSubscribe() Make a deep copy of this IODeclSubscribe.
SandInstanceMessage	cloneMessage() Calls cloneIODeclSubscribe
SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(IODeclSubscribe other, boolean deepcopy) Copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, SandInstanceMessage other) Copy the specified field from the given instance.
java.lang.String	debugDump(java.lang.String prefix) Dump this instance into a debug printable string.
void	defaultField(java.lang.String fieldname) Set the specified field to its default value.
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
boolean	fieldsValid() Validate the fields as specified in the SandInstanceMessage interface
SandAttrVal[]	fieldValidate(SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
SandCollectionMessage	find(SandQueryMessage sqm) Return a matching collection of all directly contained instances matching the given query.
java.lang.Object	generalAccessor(java.lang.String fieldspec) General field accessor method.
SandAttrVal	generalDereference(java.lang.String fieldspec) General reference field accessor method.
void	generalModifier(int action, java.lang.String field, int index, java.lang.Object val) General mutator method.
java.lang.String[]	getAllFields() Return an array of all fields for this class.
int	getBaseMemoryUse() Return the base memory use for this object.
SandCollectionMessage	getCollectionMessage() Returns null
java.lang.String[]	getContainedMessageFields() Return an array of all contained message fields.
java.lang.String[]	getDisplayFields() Return an array of the summary field names for this class.
java.lang.String[]	getDisplayFieldsPrint() Return an array of the summary field print names for this class.
java.lang.String	getDisplayID() Return the displayID for this message instance
java.lang.String[]	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	getGateway() Accessor for gateway
static java.lang.String	getGatewayDefaultValue() Default value for gateway.
java.lang.String	getGatewayFieldPrintValue() Return the print name of the gateway field.
static boolean	getGatewayFlag(int fieldflag) Field flag accessor.
static java.lang.String	getGatewayInvalidValue() Invalid value for gateway.
static int	getGatewayLengthMax() Maximum gateway length is 80 characters
static int	getGatewayLengthNorm() Normal gateway length is 10 characters
java.lang.String	getGatewayMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getGatewayPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getGatewayRange() Return the range specification for this field
java.lang.String	getGatewayValidityCheck() 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	getLayoutXML() Return the fieldlayout XML or null if not defined.
int	getMode() Accessor for mode
static java.lang.String[]	getModeActualVals() Return an array of the possible values for this field as Strings.
static int	getModeDefaultValue() Default value for mode.
static java.lang.String	getModeEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getModeFieldPrintValue() Return the print name of the mode field.
static boolean	getModeFlag(int fieldflag) Field flag accessor.
static int	getModeInvalidValue() Invalid value for mode.
static java.lang.String[]	getModeKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getModeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getModePrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getModePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getModeRange() Return the range specification for this field
java.lang.String	getModeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getOptimize() Accessor for optimize
static java.lang.String[]	getOptimizeActualVals() Return an array of the possible values for this field as Strings.
static int	getOptimizeDefaultValue() Default value for optimize.
static java.lang.String	getOptimizeEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getOptimizeFieldPrintValue() Return the print name of the optimize field.
static boolean	getOptimizeFlag(int fieldflag) Field flag accessor.
static int	getOptimizeInvalidValue() Invalid value for optimize.
static java.lang.String[]	getOptimizeKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getOptimizeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getOptimizePrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getOptimizePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getOptimizeRange() Return the range specification for this field
java.lang.String	getOptimizeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getPrintname() Return the printname of the class
java.lang.String	getPrintnameForField(java.lang.String fieldname) Given a fieldname, return its declared printname if declared.
SandQueryMessage	getQueryMessage() Returns null
java.lang.String	getShortName() Returns the unqualified name of this message.
SandStructMessage	getStructMessage() Returns a new IODeclSubscribe instance
java.lang.String	getTarget() Accessor for target
static java.lang.String	getTargetDefaultValue() Default value for target.
java.lang.String	getTargetFieldPrintValue() Return the print name of the target field.
static boolean	getTargetFlag(int fieldflag) Field flag accessor.
static java.lang.String	getTargetInvalidValue() Invalid value for target.
static int	getTargetLengthMax() Maximum target length is 80 characters
static int	getTargetLengthNorm() Normal target length is 10 characters
java.lang.String	getTargetMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getTargetPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getTargetRange() Return the range specification for this field
java.lang.String	getTargetValidityCheck() 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.
static java.lang.String	modeActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	modeLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	modeLabelToValueStatic(java.lang.String label)
static java.lang.String	modePrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	modePrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	modeValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	modeValueToLabelStatic(int val)
static java.lang.String	optimizeActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	optimizeLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	optimizeLabelToValueStatic(java.lang.String label)
static java.lang.String	optimizePrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	optimizePrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	optimizeValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	optimizeValueToLabelStatic(int val)
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	setGateway(java.lang.Object gateway) Generic mutator for gateway
void	setGateway(java.lang.String gateway) Mutator for gateway
void	setMode(int mode) Mutator for mode
void	setOptimize(int optimize) Mutator for optimize
void	setTarget(java.lang.Object target) Generic mutator for target
void	setTarget(java.lang.String target) Mutator for target
IODeclSubscribe	shallowCopy() Make a shallow copy of this IODeclSubscribe.
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

MODE_INVALID

public static final int MODE_INVALID

Possible value for mode

See Also:

Constant Field Values

MODE_DIRECT

public static final int MODE_DIRECT

Possible value for mode

See Also:

Constant Field Values

MODE_SECURE

public static final int MODE_SECURE

Possible value for mode

See Also:

Constant Field Values

OPTIMIZE_IF_POSSIBLE

public static final int OPTIMIZE_IF_POSSIBLE

Possible value for optimize

See Also:

Constant Field Values

OPTIMIZE_NEVER

public static final int OPTIMIZE_NEVER

Possible value for optimize

See Also:

Constant Field Values

Constructor Detail

IODeclSubscribe

public IODeclSubscribe()

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

getMode

public int getMode()

Accessor for mode

Specified by:

getMode in interface IODeclBaseInterface

setMode

public void setMode(int mode)

Mutator for mode

Specified by:

setMode in interface IODeclBaseInterface

modeValueToLabel

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

modeValueToLabelStatic

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

modeLabelToValue

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

modeLabelToValueStatic

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

getModePrintVals

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

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.

getModeKeyVals

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

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.

getModeActualVals

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

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

modePrint2Key

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

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

modePrint2Actual

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

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

modeActual2Print

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

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

getModeEnumSummary

public static java.lang.String getModeEnumSummary()

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

getModeFlag

public static boolean getModeFlag(int fieldflag)

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

getModeDefaultValue

public static int getModeDefaultValue()

Default value for mode. Returns 0

getModeInvalidValue

public static int getModeInvalidValue()

Invalid value for mode. Returns 0

getModePrintValue

public java.lang.String getModePrintValue()

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.

getModeFieldPrintValue

public java.lang.String getModeFieldPrintValue()

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

getModeRange

public java.lang.String getModeRange()

Return the range specification for this field

getModeValidityCheck

public java.lang.String getModeValidityCheck()

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.

getModeMetatype

public java.lang.String getModeMetatype()

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

getOptimize

public int getOptimize()

Accessor for optimize

Specified by:

getOptimize in interface IODeclBaseInterface

setOptimize

public void setOptimize(int optimize)

Mutator for optimize

Specified by:

setOptimize in interface IODeclBaseInterface

optimizeValueToLabel

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

optimizeValueToLabelStatic

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

optimizeLabelToValue

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

optimizeLabelToValueStatic

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

getOptimizePrintVals

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

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.

getOptimizeKeyVals

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

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.

getOptimizeActualVals

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

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

optimizePrint2Key

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

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

optimizePrint2Actual

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

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

optimizeActual2Print

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

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

getOptimizeEnumSummary

public static java.lang.String getOptimizeEnumSummary()

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

getOptimizeFlag

public static boolean getOptimizeFlag(int fieldflag)

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

getOptimizeDefaultValue

public static int getOptimizeDefaultValue()

Default value for optimize. Returns OPTIMIZE_IF_POSSIBLE

getOptimizeInvalidValue

public static int getOptimizeInvalidValue()

Invalid value for optimize. Returns -1

getOptimizePrintValue

public java.lang.String getOptimizePrintValue()

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.

getOptimizeFieldPrintValue

public java.lang.String getOptimizeFieldPrintValue()

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

getOptimizeRange

public java.lang.String getOptimizeRange()

Return the range specification for this field

getOptimizeValidityCheck

public java.lang.String getOptimizeValidityCheck()

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.

getOptimizeMetatype

public java.lang.String getOptimizeMetatype()

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

getGateway

public java.lang.String getGateway()

Accessor for gateway

Specified by:

getGateway in interface IODeclBaseInterface

setGateway

public void setGateway(java.lang.String gateway)

Mutator for gateway

Specified by:

setGateway in interface IODeclBaseInterface

setGateway

public void setGateway(java.lang.Object gateway)

Generic mutator for gateway

Specified by:

setGateway in interface IODeclBaseInterface

getGatewayFlag

public static boolean getGatewayFlag(int fieldflag)

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

getGatewayLengthNorm

public static int getGatewayLengthNorm()

Normal gateway length is 10 characters

getGatewayLengthMax

public static int getGatewayLengthMax()

Maximum gateway length is 80 characters

getGatewayDefaultValue

public static java.lang.String getGatewayDefaultValue()

Default value for gateway. Returns ""

getGatewayInvalidValue

public static java.lang.String getGatewayInvalidValue()

Invalid value for gateway. Returns null

getGatewayPrintValue

public java.lang.String getGatewayPrintValue()

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.

getGatewayFieldPrintValue

public java.lang.String getGatewayFieldPrintValue()

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

getGatewayRange

public java.lang.String getGatewayRange()

Return the range specification for this field

getGatewayValidityCheck

public java.lang.String getGatewayValidityCheck()

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.

getGatewayMetatype

public java.lang.String getGatewayMetatype()

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

getTarget

public java.lang.String getTarget()

Accessor for target

setTarget

public void setTarget(java.lang.String target)

Mutator for target

setTarget

public void setTarget(java.lang.Object target)

Generic mutator for target

getTargetFlag

public static boolean getTargetFlag(int fieldflag)

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

getTargetLengthNorm

public static int getTargetLengthNorm()

Normal target length is 10 characters

getTargetLengthMax

public static int getTargetLengthMax()

Maximum target length is 80 characters

getTargetDefaultValue

public static java.lang.String getTargetDefaultValue()

Default value for target. Returns ""

getTargetInvalidValue

public static java.lang.String getTargetInvalidValue()

Invalid value for target. Returns null

getTargetPrintValue

public java.lang.String getTargetPrintValue()

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.

getTargetFieldPrintValue

public java.lang.String getTargetFieldPrintValue()

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

getTargetRange

public java.lang.String getTargetRange()

Return the range specification for this field

getTargetValidityCheck

public java.lang.String getTargetValidityCheck()

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.

getTargetMetatype

public java.lang.String getTargetMetatype()

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 IODeclSubscribe 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.

Specified by:

getValueForFieldName in interface IODeclBaseInterface

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 cloneIODeclSubscribe

Specified by:

cloneMessage in interface SandInstanceMessage

cloneIODeclSubscribe

public IODeclSubscribe cloneIODeclSubscribe()

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

shallowCopy

public IODeclSubscribe shallowCopy()

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

copyDataFrom

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