org.sandev.TaskHeap.sandmessages
Class DisplayParams

java.lang.Object
  org.sandev.TaskHeap.structs.DisplayParamsStruct
      org.sandev.TaskHeap.sandmessages.DisplayParams

All Implemented Interfaces:

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

public class DisplayParams

extends DisplayParamsStruct

implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.structs.DisplayParamsStruct
generator: org.sandev.generator.MessageClassGenerator
time: Dec 2, 2005 6:38:51 PM

Field Summary

static int	DISPLAYMODE_ALL Possible value for displayMode
static int	DISPLAYMODE_HIDEDONE Possible value for displayMode
static int	DISPLAYMODE_LEVEL2 Possible value for displayMode
static int	DISPLAYMODE_LEVEL3 Possible value for displayMode
static int	DISPLAYMODE_LEVEL4 Possible value for displayMode
static int	DISPLAYMODE_NORMAL Possible value for displayMode
static int	DISPLAYMODE_SUBROOT Possible value for displayMode
static int	DISPLAYMODE_TIMEONLY Possible value for displayMode
static int	VIEWMODE_DEADALL Possible value for viewMode
static int	VIEWMODE_DEADLINE Possible value for viewMode
static int	VIEWMODE_DEADREM Possible value for viewMode
static int	VIEWMODE_DEADTTL Possible value for viewMode
static int	VIEWMODE_PROJALL Possible value for viewMode
static int	VIEWMODE_PROJECTED Possible value for viewMode
static int	VIEWMODE_PROJREM Possible value for viewMode
static int	VIEWMODE_PROJTTL Possible value for viewMode

Fields inherited from class org.sandev.TaskHeap.structs.DisplayParamsStruct

currPlan, displayMode, previousRoot, rootPlan, viewMode

Fields inherited from interface org.sandev.basics.structs.SandInstanceMessage

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_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET

Constructor Summary

DisplayParams()
Default constructor calls init.

Method Summary

DisplayParams	cloneDisplayParams() Make a deep copy of this DisplayParams.
org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls cloneDisplayParams
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(DisplayParams other) Deep 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.
static java.lang.String	displayModeActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	displayModeLabelToValue(java.lang.String label) Given a label, return the value for it.
static java.lang.String	displayModePrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	displayModePrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	displayModeValueToLabel(int val) Given a value, return the declared label for it.
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
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[]	getAllFields() Return an array of all fields for this class.
org.sandev.basics.structs.SandCollectionMessage	getCollectionMessage() Returns null
long	getCurrPlan() Accessor for currPlan
static long	getCurrPlanDefaultValue() Default value for currPlan.
java.lang.String	getCurrPlanFieldPrintValue() Return the print name of the currPlan field.
static boolean	getCurrPlanFlag(int fieldflag) Field flag accessor.
static long	getCurrPlanInvalidValue() Invalid value for currPlan.
java.lang.String	getCurrPlanMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getCurrPlanPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getCurrPlanRange() Return the range specification for this field
java.lang.String	getCurrPlanValidityCheck() 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.
int	getDisplayMode() Accessor for displayMode
static java.lang.String[]	getDisplayModeActualVals() Return an array of the possible values for this field as Strings.
static int	getDisplayModeDefaultValue() Default value for displayMode.
static java.lang.String	getDisplayModeEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getDisplayModeFieldPrintValue() Return the print name of the displayMode field.
static boolean	getDisplayModeFlag(int fieldflag) Field flag accessor.
static int	getDisplayModeInvalidValue() Invalid value for displayMode.
static java.lang.String[]	getDisplayModeKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getDisplayModeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getDisplayModePrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getDisplayModePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDisplayModeRange() Return the range specification for this field
java.lang.String	getDisplayModeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String[]	getDisplayValues() Return the values for the summary fields.
java.lang.String[]	getDisplayValues(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.
long	getPreviousRoot() Accessor for previousRoot
static long	getPreviousRootDefaultValue() Default value for previousRoot.
java.lang.String	getPreviousRootFieldPrintValue() Return the print name of the previousRoot field.
static boolean	getPreviousRootFlag(int fieldflag) Field flag accessor.
static long	getPreviousRootInvalidValue() Invalid value for previousRoot.
java.lang.String	getPreviousRootMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getPreviousRootPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getPreviousRootRange() Return the range specification for this field
java.lang.String	getPreviousRootValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.SandQueryMessage	getQueryMessage() Returns null
long	getRootPlan() Accessor for rootPlan
static long	getRootPlanDefaultValue() Default value for rootPlan.
java.lang.String	getRootPlanFieldPrintValue() Return the print name of the rootPlan field.
static boolean	getRootPlanFlag(int fieldflag) Field flag accessor.
static long	getRootPlanInvalidValue() Invalid value for rootPlan.
java.lang.String	getRootPlanMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getRootPlanPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getRootPlanRange() Return the range specification for this field
java.lang.String	getRootPlanValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getShortName() Returns the unqualified name of this message.
org.sandev.basics.structs.SandStructMessage	getStructMessage() Returns a new DisplayParams instance
org.sandev.basics.structs.SandUpdateMessage	getUpdateMessage() Returns a new DisplayParamsUpdate instance
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.
int	getViewMode() Accessor for viewMode
static java.lang.String[]	getViewModeActualVals() Return an array of the possible values for this field as Strings.
static int	getViewModeDefaultValue() Default value for viewMode.
static java.lang.String	getViewModeEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getViewModeFieldPrintValue() Return the print name of the viewMode field.
static boolean	getViewModeFlag(int fieldflag) Field flag accessor.
static int	getViewModeInvalidValue() Invalid value for viewMode.
static java.lang.String[]	getViewModeKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getViewModeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getViewModePrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getViewModePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getViewModeRange() Return the range specification for this field
java.lang.String	getViewModeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
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.
Plan	resolveCurrPlanReference(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Converts a reference to an instance by looking it up.
Plan	resolveCurrPlanReferenceNonCrit(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Calls standard method, eating any SandException and returning a new instance uniqueID -1.
Plan	resolvePreviousRootReference(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Converts a reference to an instance by looking it up.
Plan	resolvePreviousRootReferenceNonCrit(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Calls standard method, eating any SandException and returning a new instance uniqueID -1.
Plan	resolveRootPlanReference(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Converts a reference to an instance by looking it up.
Plan	resolveRootPlanReferenceNonCrit(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Calls standard method, eating any SandException and returning a new instance uniqueID -1.
void	setCurrPlan(long currPlan) Mutator for currPlan
void	setDisplayMode(int displayMode) Mutator for displayMode
void	setPreviousRoot(long previousRoot) Mutator for previousRoot
void	setRootPlan(long rootPlan) Mutator for rootPlan
void	setViewMode(int viewMode) Mutator for viewMode
java.lang.String	toString() Return a string representation of this object.
static java.lang.String	viewModeActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	viewModeLabelToValue(java.lang.String label) Given a label, return the value for it.
static java.lang.String	viewModePrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	viewModePrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	viewModeValueToLabel(int val) Given a value, return the declared label for it.

Methods inherited from class java.lang.Object

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

Field Detail

DISPLAYMODE_ALL

public static final int DISPLAYMODE_ALL

Possible value for displayMode

See Also:

Constant Field Values

DISPLAYMODE_NORMAL

public static final int DISPLAYMODE_NORMAL

Possible value for displayMode

See Also:

Constant Field Values

DISPLAYMODE_HIDEDONE

public static final int DISPLAYMODE_HIDEDONE

Possible value for displayMode

See Also:

Constant Field Values

DISPLAYMODE_TIMEONLY

public static final int DISPLAYMODE_TIMEONLY

Possible value for displayMode

See Also:

Constant Field Values

DISPLAYMODE_LEVEL2

public static final int DISPLAYMODE_LEVEL2

Possible value for displayMode

See Also:

Constant Field Values

DISPLAYMODE_LEVEL3

public static final int DISPLAYMODE_LEVEL3

Possible value for displayMode

See Also:

Constant Field Values

DISPLAYMODE_LEVEL4

public static final int DISPLAYMODE_LEVEL4

Possible value for displayMode

See Also:

Constant Field Values

DISPLAYMODE_SUBROOT

public static final int DISPLAYMODE_SUBROOT

Possible value for displayMode

See Also:

Constant Field Values

VIEWMODE_PROJALL

public static final int VIEWMODE_PROJALL

Possible value for viewMode

See Also:

Constant Field Values

VIEWMODE_PROJREM

public static final int VIEWMODE_PROJREM

Possible value for viewMode

See Also:

Constant Field Values

VIEWMODE_PROJTTL

public static final int VIEWMODE_PROJTTL

Possible value for viewMode

See Also:

Constant Field Values

VIEWMODE_PROJECTED

public static final int VIEWMODE_PROJECTED

Possible value for viewMode

See Also:

Constant Field Values

VIEWMODE_DEADALL

public static final int VIEWMODE_DEADALL

Possible value for viewMode

See Also:

Constant Field Values

VIEWMODE_DEADREM

public static final int VIEWMODE_DEADREM

Possible value for viewMode

See Also:

Constant Field Values

VIEWMODE_DEADTTL

public static final int VIEWMODE_DEADTTL

Possible value for viewMode

See Also:

Constant Field Values

VIEWMODE_DEADLINE

public static final int VIEWMODE_DEADLINE

Possible value for viewMode

See Also:

Constant Field Values

Constructor Detail

DisplayParams

public DisplayParams()

Default constructor calls init.

Method Detail

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

getCurrPlan

public long getCurrPlan()

Accessor for currPlan

setCurrPlan

public void setCurrPlan(long currPlan)

Mutator for currPlan

getCurrPlanFlag

public static boolean getCurrPlanFlag(int fieldflag)

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

getCurrPlanDefaultValue

public static long getCurrPlanDefaultValue()

Default value for currPlan. Returns 0

getCurrPlanInvalidValue

public static long getCurrPlanInvalidValue()

Invalid value for currPlan. Returns Long.MIN_VALUE

getCurrPlanPrintValue

public java.lang.String getCurrPlanPrintValue()

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.

getCurrPlanFieldPrintValue

public java.lang.String getCurrPlanFieldPrintValue()

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

getCurrPlanRange

public java.lang.String getCurrPlanRange()

Return the range specification for this field

resolveCurrPlanReferenceNonCrit

public Plan resolveCurrPlanReferenceNonCrit(org.sandev.basics.util.IDLookup lookup,
                                            org.sandev.basics.util.AuthUser au)

Calls standard method, eating any SandException and returning a new instance uniqueID -1. This is to support the UI, which is basically calling to get detail for a richer display. If the detail is not available, it's not critical (hence the name).

resolveCurrPlanReference

public Plan resolveCurrPlanReference(org.sandev.basics.util.IDLookup lookup,
                                     org.sandev.basics.util.AuthUser au)
                              throws org.sandev.basics.structs.SandException

Converts a reference to an instance by looking it up.

Throws:

org.sandev.basics.structs.SandException

getCurrPlanValidityCheck

public java.lang.String getCurrPlanValidityCheck()

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.

getCurrPlanMetatype

public java.lang.String getCurrPlanMetatype()

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

getDisplayMode

public int getDisplayMode()

Accessor for displayMode

setDisplayMode

public void setDisplayMode(int displayMode)

Mutator for displayMode

displayModeValueToLabel

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

displayModeLabelToValue

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

getDisplayModePrintVals

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

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.

getDisplayModeKeyVals

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

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.

getDisplayModeActualVals

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

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

displayModePrint2Key

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

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

displayModePrint2Actual

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

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

displayModeActual2Print

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

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

getDisplayModeEnumSummary

public static java.lang.String getDisplayModeEnumSummary()

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

getDisplayModeFlag

public static boolean getDisplayModeFlag(int fieldflag)

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

getDisplayModeDefaultValue

public static int getDisplayModeDefaultValue()

Default value for displayMode. Returns DISPLAYMODE_NORMAL

getDisplayModeInvalidValue

public static int getDisplayModeInvalidValue()

Invalid value for displayMode. Returns -1

getDisplayModePrintValue

public java.lang.String getDisplayModePrintValue()

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.

getDisplayModeFieldPrintValue

public java.lang.String getDisplayModeFieldPrintValue()

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

getDisplayModeRange

public java.lang.String getDisplayModeRange()

Return the range specification for this field

getDisplayModeValidityCheck

public java.lang.String getDisplayModeValidityCheck()

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.

getDisplayModeMetatype

public java.lang.String getDisplayModeMetatype()

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

getRootPlan

public long getRootPlan()

Accessor for rootPlan

setRootPlan

public void setRootPlan(long rootPlan)

Mutator for rootPlan

getRootPlanFlag

public static boolean getRootPlanFlag(int fieldflag)

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

getRootPlanDefaultValue

public static long getRootPlanDefaultValue()

Default value for rootPlan. Returns 0

getRootPlanInvalidValue

public static long getRootPlanInvalidValue()

Invalid value for rootPlan. Returns Long.MIN_VALUE

getRootPlanPrintValue

public java.lang.String getRootPlanPrintValue()

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.

getRootPlanFieldPrintValue

public java.lang.String getRootPlanFieldPrintValue()

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

getRootPlanRange

public java.lang.String getRootPlanRange()

Return the range specification for this field

resolveRootPlanReferenceNonCrit

public Plan resolveRootPlanReferenceNonCrit(org.sandev.basics.util.IDLookup lookup,
                                            org.sandev.basics.util.AuthUser au)

Calls standard method, eating any SandException and returning a new instance uniqueID -1. This is to support the UI, which is basically calling to get detail for a richer display. If the detail is not available, it's not critical (hence the name).

resolveRootPlanReference

public Plan resolveRootPlanReference(org.sandev.basics.util.IDLookup lookup,
                                     org.sandev.basics.util.AuthUser au)
                              throws org.sandev.basics.structs.SandException

Converts a reference to an instance by looking it up.

Throws:

org.sandev.basics.structs.SandException

getRootPlanValidityCheck

public java.lang.String getRootPlanValidityCheck()

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.

getRootPlanMetatype

public java.lang.String getRootPlanMetatype()

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

getPreviousRoot

public long getPreviousRoot()

Accessor for previousRoot

setPreviousRoot

public void setPreviousRoot(long previousRoot)

Mutator for previousRoot

getPreviousRootFlag

public static boolean getPreviousRootFlag(int fieldflag)

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

getPreviousRootDefaultValue

public static long getPreviousRootDefaultValue()

Default value for previousRoot. Returns 0

getPreviousRootInvalidValue

public static long getPreviousRootInvalidValue()

Invalid value for previousRoot. Returns Long.MIN_VALUE

getPreviousRootPrintValue

public java.lang.String getPreviousRootPrintValue()

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.

getPreviousRootFieldPrintValue

public java.lang.String getPreviousRootFieldPrintValue()

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

getPreviousRootRange

public java.lang.String getPreviousRootRange()

Return the range specification for this field

resolvePreviousRootReferenceNonCrit

public Plan resolvePreviousRootReferenceNonCrit(org.sandev.basics.util.IDLookup lookup,
                                                org.sandev.basics.util.AuthUser au)

Calls standard method, eating any SandException and returning a new instance uniqueID -1. This is to support the UI, which is basically calling to get detail for a richer display. If the detail is not available, it's not critical (hence the name).

resolvePreviousRootReference

public Plan resolvePreviousRootReference(org.sandev.basics.util.IDLookup lookup,
                                         org.sandev.basics.util.AuthUser au)
                                  throws org.sandev.basics.structs.SandException

Converts a reference to an instance by looking it up.

Throws:

org.sandev.basics.structs.SandException

getPreviousRootValidityCheck

public java.lang.String getPreviousRootValidityCheck()

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.

getPreviousRootMetatype

public java.lang.String getPreviousRootMetatype()

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

getViewMode

public int getViewMode()

Accessor for viewMode

setViewMode

public void setViewMode(int viewMode)

Mutator for viewMode

viewModeValueToLabel

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

viewModeLabelToValue

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

getViewModePrintVals

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

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.

getViewModeKeyVals

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

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.

getViewModeActualVals

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

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

viewModePrint2Key

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

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

viewModePrint2Actual

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

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

viewModeActual2Print

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

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

getViewModeEnumSummary

public static java.lang.String getViewModeEnumSummary()

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

getViewModeFlag

public static boolean getViewModeFlag(int fieldflag)

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

getViewModeDefaultValue

public static int getViewModeDefaultValue()

Default value for viewMode. Returns 0

getViewModeInvalidValue

public static int getViewModeInvalidValue()

Invalid value for viewMode. Returns -1

getViewModePrintValue

public java.lang.String getViewModePrintValue()

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.

getViewModeFieldPrintValue

public java.lang.String getViewModeFieldPrintValue()

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

getViewModeRange

public java.lang.String getViewModeRange()

Return the range specification for this field

getViewModeValidityCheck

public java.lang.String getViewModeValidityCheck()

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.

getViewModeMetatype

public java.lang.String getViewModeMetatype()

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

Specified by:

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

getStructMessage

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

Returns a new DisplayParams 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.

Specified by:

isEquivalent 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

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.

toString

public java.lang.String toString()

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

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

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

cloneMessage

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

Calls cloneDisplayParams

Specified by:

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

cloneDisplayParams

public DisplayParams cloneDisplayParams()

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

copyDataFrom

public void copyDataFrom(DisplayParams other)

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

copyFieldValue

public void copyFieldValue(java.lang.String fieldName,
                           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