org.sandev.ui.sandmessages
Class Action

java.lang.Object
  org.sandev.ui.structs.ActionStruct
      org.sandev.ui.sandmessages.Action

All Implemented Interfaces:

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

public class Action
extends ActionStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable

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

Field Summary

static int	ACTIONSTATUS_ACTIVE Possible value for actionStatus
static int	ACTIONSTATUS_DISABLED Possible value for actionStatus
static int	ACTIONSTATUS_INACTIVE Possible value for actionStatus
static int	ACTIONSTATUS_UNCONDITIONAL Possible value for actionStatus
static int	ACTIONTYPE_REQUEST Possible value for actionType
static int	ACTIONTYPE_SETUP Possible value for actionType
static int	ACTIONTYPE_VALUE Possible value for actionType

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

actionStatus, actionType, confirm, displayName, name

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

Action()
Default constructor calls init.

Method Summary

static java.lang.String	actionStatusActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	actionStatusLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	actionStatusLabelToValueStatic(java.lang.String label)
static java.lang.String	actionStatusPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	actionStatusPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	actionStatusValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	actionStatusValueToLabelStatic(int val)
static java.lang.String	actionTypeActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	actionTypeLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	actionTypeLabelToValueStatic(java.lang.String label)
static java.lang.String	actionTypePrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	actionTypePrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	actionTypeValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	actionTypeValueToLabelStatic(int val)
Action	cloneAction() Make a deep copy of this Action.
org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls cloneAction
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(Action other, boolean deepcopy) Copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.SandInstanceMessage other) Copy the specified field from the given instance.
java.lang.String	debugDump(java.lang.String prefix) Dump this instance into a debug printable string.
void	defaultField(java.lang.String fieldname) Set the specified field to its default value.
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
boolean	fieldsValid() Validate the fields as specified in the SandInstanceMessage interface
org.sandev.basics.structs.SandAttrVal[]	fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
org.sandev.basics.structs.SandCollectionMessage	find(org.sandev.basics.structs.SandQueryMessage sqm) Return a matching collection of all directly contained instances matching the given query.
java.lang.Object	generalAccessor(java.lang.String fieldspec) General field accessor method.
org.sandev.basics.structs.SandAttrVal	generalDereference(java.lang.String fieldspec) General reference field accessor method.
void	generalModifier(int action, java.lang.String field, int index, java.lang.Object val) General mutator method.
int	getActionStatus() Accessor for actionStatus
static java.lang.String[]	getActionStatusActualVals() Return an array of the possible values for this field as Strings.
static int	getActionStatusDefaultValue() Default value for actionStatus.
static java.lang.String	getActionStatusEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getActionStatusFieldPrintValue() Return the print name of the actionStatus field.
static boolean	getActionStatusFlag(int fieldflag) Field flag accessor.
static int	getActionStatusInvalidValue() Invalid value for actionStatus.
static java.lang.String[]	getActionStatusKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getActionStatusMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getActionStatusPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getActionStatusPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getActionStatusRange() Return the range specification for this field
java.lang.String	getActionStatusValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getActionType() Accessor for actionType
static java.lang.String[]	getActionTypeActualVals() Return an array of the possible values for this field as Strings.
static int	getActionTypeDefaultValue() Default value for actionType.
static java.lang.String	getActionTypeEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getActionTypeFieldPrintValue() Return the print name of the actionType field.
static boolean	getActionTypeFlag(int fieldflag) Field flag accessor.
static int	getActionTypeInvalidValue() Invalid value for actionType.
static java.lang.String[]	getActionTypeKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getActionTypeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getActionTypePrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getActionTypePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getActionTypeRange() Return the range specification for this field
java.lang.String	getActionTypeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String[]	getAllFields() Return an array of all fields for this class.
int	getBaseMemoryUse() Return the base memory use for this object.
org.sandev.basics.structs.SandCollectionMessage	getCollectionMessage() Returns null
java.lang.String	getConfirm() Accessor for confirm
static java.lang.String	getConfirmDefaultValue() Default value for confirm.
java.lang.String	getConfirmFieldPrintValue() Return the print name of the confirm field.
static boolean	getConfirmFlag(int fieldflag) Field flag accessor.
static java.lang.String	getConfirmInvalidValue() Invalid value for confirm.
static int	getConfirmLengthMax() Maximum confirm length is 512 characters
static int	getConfirmLengthNorm() Normal confirm length is 70 characters
java.lang.String	getConfirmMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getConfirmPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getConfirmRange() Return the range specification for this field
java.lang.String	getConfirmValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
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	getDisplayName() Accessor for displayName
static java.lang.String	getDisplayNameDefaultValue() Default value for displayName.
java.lang.String	getDisplayNameFieldPrintValue() Return the print name of the displayName field.
static boolean	getDisplayNameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getDisplayNameInvalidValue() Invalid value for displayName.
static int	getDisplayNameLengthMax() Maximum displayName length is 70 characters
static int	getDisplayNameLengthNorm() Normal displayName length is 30 characters
java.lang.String	getDisplayNameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getDisplayNamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDisplayNameRange() Return the range specification for this field
java.lang.String	getDisplayNameValidityCheck() 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.
org.sandev.basics.structs.SandPersistMessage	getInstance(java.lang.String classname, long id) If this instance directly contains the specified instance, then find it and return it.
org.sandev.basics.structs.SandInstanceMessage	getInstance(java.lang.String classname, java.lang.String fieldname, java.lang.String value) If this instance directly contains the specified instance, then find it and return it.
java.lang.String	getLayoutXML() Return the fieldlayout XML or null if not defined.
java.lang.String	getName() Accessor for name
static java.lang.String	getNameDefaultValue() Default value for name.
java.lang.String	getNameFieldPrintValue() Return the print name of the name field.
static boolean	getNameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getNameInvalidValue() Invalid value for name.
static int	getNameLengthMax() Maximum name length is 70 characters
static int	getNameLengthNorm() Normal name length is 30 characters
java.lang.String	getNameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getNamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getNameRange() Return the range specification for this field
java.lang.String	getNameValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getPrintname() Return the printname of the class
java.lang.String	getPrintnameForField(java.lang.String fieldname) Given a fieldname, return its declared printname if declared.
org.sandev.basics.structs.SandQueryMessage	getQueryMessage() Returns null
java.lang.String	getShortName() Returns the unqualified name of this message.
org.sandev.basics.structs.SandStructMessage	getStructMessage() Returns a new Action instance
org.sandev.basics.structs.SandUpdateMessage	getUpdateMessage() Returns null
java.lang.String	getValueForFieldName(java.lang.String fieldname, org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Returns the print representation of the value of the specified field, or the given default value if innaccessible.
void	init() Initialize all fields to their default values
boolean	isEquivalent(org.sandev.basics.structs.SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, org.sandev.basics.util.IDLookup idlookup, org.sandev.basics.util.NameLookup namelookup, org.sandev.basics.util.AuthUser au) Validate the references as specified in the Resolvable interface.
void	setActionStatus(int actionStatus) Mutator for actionStatus
void	setActionType(int actionType) Mutator for actionType
void	setConfirm(java.lang.Object confirm) Generic mutator for confirm
void	setConfirm(java.lang.String confirm) Mutator for confirm
void	setDisplayName(java.lang.Object displayName) Generic mutator for displayName
void	setDisplayName(java.lang.String displayName) Mutator for displayName
void	setName(java.lang.Object name) Generic mutator for name
void	setName(java.lang.String name) Mutator for name
Action	shallowCopy() Make a shallow copy of this Action.
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

ACTIONSTATUS_DISABLED

public static final int ACTIONSTATUS_DISABLED

Possible value for actionStatus

See Also:

Constant Field Values

ACTIONSTATUS_INACTIVE

public static final int ACTIONSTATUS_INACTIVE

Possible value for actionStatus

See Also:

Constant Field Values

ACTIONSTATUS_ACTIVE

public static final int ACTIONSTATUS_ACTIVE

Possible value for actionStatus

See Also:

Constant Field Values

ACTIONSTATUS_UNCONDITIONAL

public static final int ACTIONSTATUS_UNCONDITIONAL

Possible value for actionStatus

See Also:

Constant Field Values

ACTIONTYPE_SETUP

public static final int ACTIONTYPE_SETUP

Possible value for actionType

See Also:

Constant Field Values

ACTIONTYPE_REQUEST

public static final int ACTIONTYPE_REQUEST

Possible value for actionType

See Also:

Constant Field Values

ACTIONTYPE_VALUE

public static final int ACTIONTYPE_VALUE

Possible value for actionType

See Also:

Constant Field Values

Constructor Detail

Action

public Action()

Default constructor calls init.

Method Detail

getPrintname

public java.lang.String getPrintname()

Return the printname of the class

Specified by:

getPrintname in interface org.sandev.basics.structs.SandStructMessage

fieldHasFlag

public boolean fieldHasFlag(java.lang.String fieldname,
                            int fieldflag)

Return true if the named field declares the indicated flag, false otherwise. See the FIELDFLAG* constants in SandInstanceMessage for supported fieldflag values.

Specified by:

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

getDisplayName

public java.lang.String getDisplayName()

Accessor for displayName

setDisplayName

public void setDisplayName(java.lang.String displayName)

Mutator for displayName

setDisplayName

public void setDisplayName(java.lang.Object displayName)

Generic mutator for displayName

getDisplayNameFlag

public static boolean getDisplayNameFlag(int fieldflag)

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

getDisplayNameLengthNorm

public static int getDisplayNameLengthNorm()

Normal displayName length is 30 characters

getDisplayNameLengthMax

public static int getDisplayNameLengthMax()

Maximum displayName length is 70 characters

getDisplayNameDefaultValue

public static java.lang.String getDisplayNameDefaultValue()

Default value for displayName. Returns ""

getDisplayNameInvalidValue

public static java.lang.String getDisplayNameInvalidValue()

Invalid value for displayName. Returns null

getDisplayNamePrintValue

public java.lang.String getDisplayNamePrintValue()

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.

getDisplayNameFieldPrintValue

public java.lang.String getDisplayNameFieldPrintValue()

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

getDisplayNameRange

public java.lang.String getDisplayNameRange()

Return the range specification for this field

getDisplayNameValidityCheck

public java.lang.String getDisplayNameValidityCheck()

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.

getDisplayNameMetatype

public java.lang.String getDisplayNameMetatype()

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

getName

public java.lang.String getName()

Accessor for name

setName

public void setName(java.lang.String name)

Mutator for name

setName

public void setName(java.lang.Object name)

Generic mutator for name

getNameFlag

public static boolean getNameFlag(int fieldflag)

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

getNameLengthNorm

public static int getNameLengthNorm()

Normal name length is 30 characters

getNameLengthMax

public static int getNameLengthMax()

Maximum name length is 70 characters

getNameDefaultValue

public static java.lang.String getNameDefaultValue()

Default value for name. Returns ""

getNameInvalidValue

public static java.lang.String getNameInvalidValue()

Invalid value for name. Returns null

getNamePrintValue

public java.lang.String getNamePrintValue()

Retrieve the current value of this field as a print String. For a String field, this returns the current value. For int, long, double this returns the standard string conversion. For a Date, this returns the default DateFormat format. For an enum, this returns the Actual2Print translation of the current value. For a struct this returns a summary description.

Used for debug output, and as an initial value for transformation and formatting.

getNameFieldPrintValue

public java.lang.String getNameFieldPrintValue()

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

getNameRange

public java.lang.String getNameRange()

Return the range specification for this field

getNameValidityCheck

public java.lang.String getNameValidityCheck()

Return the empty string if the value of this field is valid according to the base SAND declarations. This method supports the fieldValidate method, which is in turn specified by the org.sandev.basics.structs.SandInstanceMessage interface. See the comments there for more information, including a list of error Strings returned from here when a field is not valid.

getNameMetatype

public java.lang.String getNameMetatype()

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

getActionStatus

public int getActionStatus()

Accessor for actionStatus

setActionStatus

public void setActionStatus(int actionStatus)

Mutator for actionStatus

actionStatusValueToLabel

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

actionStatusValueToLabelStatic

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

actionStatusLabelToValue

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

actionStatusLabelToValueStatic

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

getActionStatusPrintVals

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

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.

getActionStatusKeyVals

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

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.

getActionStatusActualVals

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

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

actionStatusPrint2Key

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

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

actionStatusPrint2Actual

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

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

actionStatusActual2Print

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

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

getActionStatusEnumSummary

public static java.lang.String getActionStatusEnumSummary()

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

getActionStatusFlag

public static boolean getActionStatusFlag(int fieldflag)

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

getActionStatusDefaultValue

public static int getActionStatusDefaultValue()

Default value for actionStatus. Returns ACTIONSTATUS_INACTIVE

getActionStatusInvalidValue

public static int getActionStatusInvalidValue()

Invalid value for actionStatus. Returns 0

getActionStatusPrintValue

public java.lang.String getActionStatusPrintValue()

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.

getActionStatusFieldPrintValue

public java.lang.String getActionStatusFieldPrintValue()

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

getActionStatusRange

public java.lang.String getActionStatusRange()

Return the range specification for this field

getActionStatusValidityCheck

public java.lang.String getActionStatusValidityCheck()

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.

getActionStatusMetatype

public java.lang.String getActionStatusMetatype()

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

getActionType

public int getActionType()

Accessor for actionType

setActionType

public void setActionType(int actionType)

Mutator for actionType

actionTypeValueToLabel

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

actionTypeValueToLabelStatic

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

actionTypeLabelToValue

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

actionTypeLabelToValueStatic

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

getActionTypePrintVals

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

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.

getActionTypeKeyVals

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

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.

getActionTypeActualVals

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

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

actionTypePrint2Key

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

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

actionTypePrint2Actual

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

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

actionTypeActual2Print

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

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

getActionTypeEnumSummary

public static java.lang.String getActionTypeEnumSummary()

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

getActionTypeFlag

public static boolean getActionTypeFlag(int fieldflag)

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

getActionTypeDefaultValue

public static int getActionTypeDefaultValue()

Default value for actionType. Returns ACTIONTYPE_REQUEST

getActionTypeInvalidValue

public static int getActionTypeInvalidValue()

Invalid value for actionType. Returns 0

getActionTypePrintValue

public java.lang.String getActionTypePrintValue()

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.

getActionTypeFieldPrintValue

public java.lang.String getActionTypeFieldPrintValue()

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

getActionTypeRange

public java.lang.String getActionTypeRange()

Return the range specification for this field

getActionTypeValidityCheck

public java.lang.String getActionTypeValidityCheck()

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.

getActionTypeMetatype

public java.lang.String getActionTypeMetatype()

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

getConfirm

public java.lang.String getConfirm()

Accessor for confirm

setConfirm

public void setConfirm(java.lang.String confirm)

Mutator for confirm

setConfirm

public void setConfirm(java.lang.Object confirm)

Generic mutator for confirm

getConfirmFlag

public static boolean getConfirmFlag(int fieldflag)

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

getConfirmLengthNorm

public static int getConfirmLengthNorm()

Normal confirm length is 70 characters

getConfirmLengthMax

public static int getConfirmLengthMax()

Maximum confirm length is 512 characters

getConfirmDefaultValue

public static java.lang.String getConfirmDefaultValue()

Default value for confirm. Returns ""

getConfirmInvalidValue

public static java.lang.String getConfirmInvalidValue()

Invalid value for confirm. Returns "INVALID_CONFIRM_TEXT"

getConfirmPrintValue

public java.lang.String getConfirmPrintValue()

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.

getConfirmFieldPrintValue

public java.lang.String getConfirmFieldPrintValue()

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

getConfirmRange

public java.lang.String getConfirmRange()

Return the range specification for this field

getConfirmValidityCheck

public java.lang.String getConfirmValidityCheck()

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.

getConfirmMetatype

public java.lang.String getConfirmMetatype()

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

init

public void init()

Initialize all fields to their default values

getShortName

public java.lang.String getShortName()

Returns the unqualified name of this message.

Specified by:

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

getQueryMessage

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

Returns null

Specified by:

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

getCollectionMessage

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

Returns null

Specified by:

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

getUpdateMessage

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

Returns null

Specified by:

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

getStructMessage

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

Returns a new Action instance

Specified by:

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

isEquivalent

public boolean isEquivalent(org.sandev.basics.structs.SandMessage sm)

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

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

Specified by:

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

getBaseMemoryUse

public int getBaseMemoryUse()

Return the base memory use for this object. This number is a minimum value for estimation purposes, see the comments in the SandStructMessage declaration for details.

Specified by:

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

generalModifier

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

General mutator method. Specified by SandInstanceMessage interface.

Specified by:

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

Throws:

org.sandev.basics.structs.SandException

generalDereference

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

General reference field accessor method. Specified by SandInstanceMessage interface.

Specified by:

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

generalAccessor

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

General field accessor method. Specified by SandInstanceMessage interface.

Specified by:

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

getDisplayFields

public java.lang.String[] getDisplayFields()

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

Specified by:

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

getDisplayFieldsPrint

public java.lang.String[] getDisplayFieldsPrint()

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

Specified by:

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

getLayoutXML

public java.lang.String getLayoutXML()

Return the fieldlayout XML or null if not defined.

Specified by:

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

getDisplayValues

public java.lang.String[] getDisplayValues()

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

Specified by:

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

getDisplayValues

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

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

Specified by:

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

getValueForFieldName

public java.lang.String getValueForFieldName(java.lang.String fieldname,
                                             org.sandev.basics.util.IDLookup lookup,
                                             org.sandev.basics.util.AuthUser user,
                                             java.lang.String defaultVal)

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

getAllFields

public java.lang.String[] getAllFields()

Return an array of all fields for this class.

Specified by:

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

getContainedMessageFields

public java.lang.String[] getContainedMessageFields()

Return an array of all contained message fields.

Specified by:

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

defaultField

public void defaultField(java.lang.String fieldname)

Set the specified field to its default value.

Specified by:

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

getPrintnameForField

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

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

Specified by:

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

cloneMessage

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

Calls cloneAction

Specified by:

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

cloneAction

public Action cloneAction()

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

shallowCopy

public Action shallowCopy()

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

copyDataFrom

public void copyDataFrom(Action other,
                         boolean deepcopy)

Copy all the data from the specified instance. If the other instance is null then this method does nothing. If deepcopy is specified then contained structs are copied, otherwise not. The one field this does not copy is instanceWriteAccess, since you need the copied instance to be writeable.

copyFieldValue

public void copyFieldValue(java.lang.String fieldName,
                           org.sandev.basics.structs.SandInstanceMessage other)

Copy the specified field from the given instance.

Specified by:

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

fieldValidate

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

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

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

fieldsValid

public boolean fieldsValid()

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

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

referenceValidate

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

Validate the references as specified in the Resolvable interface.

Specified by:

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

Throws:

org.sandev.basics.structs.SandException

convertToSuperstructClass

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

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

Specified by:

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

debugDump

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

Dump this instance into a debug printable string.

Specified by:

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

getDisplayID

public java.lang.String getDisplayID()

Return the displayID for this message instance

Specified by:

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

getInstance

public org.sandev.basics.structs.SandPersistMessage getInstance(java.lang.String classname,
                                                                long id)

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

Specified by:

getInstance in interface org.sandev.basics.structs.SandStructMessage

getInstance

public org.sandev.basics.structs.SandInstanceMessage getInstance(java.lang.String classname,
                                                                 java.lang.String fieldname,
                                                                 java.lang.String value)

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

Specified by:

getInstance in interface org.sandev.basics.structs.SandStructMessage

find

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

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

Specified by:

find in interface org.sandev.basics.structs.SandStructMessage

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object