org.sandev.TaskHeap.sandmessages
Class PlanUpdate

java.lang.Object
  org.sandev.TaskHeap.sandmessages.PlanUpdate

All Implemented Interfaces:

org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandTransmitMessage, org.sandev.basics.structs.SandUpdateMessage, org.sandev.basics.structs.SandVerbMessage

public class PlanUpdate

extends java.lang.Object

implements org.sandev.basics.structs.SandUpdateMessage

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

Field Summary

protected int	action support for SandUpdateMessage interface
static int	ACTION_ADDING Possible value for action
static int	ACTION_DELETING Possible value for action
static int	ACTION_UNKNOWN Possible value for action
static int	ACTION_UPDATING Possible value for action
protected Plan	plan the contained instance for this update
protected int	sandTransmissionCount support for SandTransmitMessage interface
protected long	sandTransmitAuthID support for SandTransmitMessage interface
protected java.lang.String	sandTransmitErrorMessage support for SandTransmitMessage interface
protected int	sandTransmitStatus support for SandTransmitMessage interface
protected java.lang.String	source The source of this update

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

ACTION_ADD, ACTION_DELETE, ACTION_UNDEFINED, ACTION_UPDATE, APPERROR_UPDATEFAIL_OLDVERSION, APPERROR_UPDATEFAIL_UNIQUEVIO

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

APPERROR_NODE_UNAVAILABLE, APPERROR_NODE_UNKNOWN, APPERROR_NODE_UNREACHABLE, STATUS_APPERROR, STATUS_NORMAL, STATUS_SANDERROR, STATUS_SYSERROR

Constructor Summary

PlanUpdate()
Default constructor calls init.

Method Summary

static java.lang.String	actionActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	actionLabelToValue(java.lang.String label) Given a label, return the value for it.
static java.lang.String	actionPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	actionPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	actionValueToLabel(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.
int	getAction() Accessor for action
static java.lang.String[]	getActionActualVals() Return an array of the possible values for this field as Strings.
static int	getActionDefaultValue() Default value for action.
static java.lang.String	getActionEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getActionFieldPrintValue() Return the print name of the action field.
static boolean	getActionFlag(int fieldflag) Field flag accessor.
static int	getActionInvalidValue() Invalid value for action.
static java.lang.String[]	getActionKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getActionMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getActionPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getActionPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getActionRange() Return the range specification for this field
java.lang.String	getActionValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.SandCollectionMessage	getCollectionMessage() Returns a new PlanCollection instance
org.sandev.basics.structs.SandStructMessage	getInstance() Generalized accessor for the update instance
long	getInstanceID() Return the uniqueID of the update instance, or -1 if it is not a persistent message.
Plan	getPlan() Accessor for plan
static Plan	getPlanDefaultValue() Default value for plan.
java.lang.String	getPlanFieldPrintValue() Return the print name of the plan field.
static boolean	getPlanFlag(int fieldflag) Field flag accessor.
static Plan	getPlanInvalidValue() Invalid value for plan.
java.lang.String	getPlanMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getPlanPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getPlanRange() Return the range specification for this field
java.lang.String	getPlanValidityCheck() 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 a new PlanQuery instance
int	getSandTransmissionCount() Accessor for sandTransmissionCount
static int	getSandTransmissionCountDefaultValue() Default value for sandTransmissionCount.
java.lang.String	getSandTransmissionCountFieldPrintValue() Return the print name of the sandTransmissionCount field.
static boolean	getSandTransmissionCountFlag(int fieldflag) Field flag accessor.
static int	getSandTransmissionCountInvalidValue() Invalid value for sandTransmissionCount.
java.lang.String	getSandTransmissionCountMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSandTransmissionCountPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSandTransmissionCountRange() Return the range specification for this field
java.lang.String	getSandTransmissionCountValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
long	getSandTransmitAuthID() Accessor for sandTransmitAuthID
static long	getSandTransmitAuthIDDefaultValue() Default value for sandTransmitAuthID.
java.lang.String	getSandTransmitAuthIDFieldPrintValue() Return the print name of the sandTransmitAuthID field.
static boolean	getSandTransmitAuthIDFlag(int fieldflag) Field flag accessor.
static long	getSandTransmitAuthIDInvalidValue() Invalid value for sandTransmitAuthID.
java.lang.String	getSandTransmitAuthIDMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSandTransmitAuthIDPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSandTransmitAuthIDRange() Return the range specification for this field
java.lang.String	getSandTransmitAuthIDValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getSandTransmitErrorMessage() Accessor for sandTransmitErrorMessage
static java.lang.String	getSandTransmitErrorMessageDefaultValue() Default value for sandTransmitErrorMessage.
java.lang.String	getSandTransmitErrorMessageFieldPrintValue() Return the print name of the sandTransmitErrorMessage field.
static boolean	getSandTransmitErrorMessageFlag(int fieldflag) Field flag accessor.
static java.lang.String	getSandTransmitErrorMessageInvalidValue() Invalid value for sandTransmitErrorMessage.
static int	getSandTransmitErrorMessageLengthMax() Maximum sandTransmitErrorMessage length is 70 characters
static int	getSandTransmitErrorMessageLengthNorm() Normal sandTransmitErrorMessage length is 30 characters
java.lang.String	getSandTransmitErrorMessageMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSandTransmitErrorMessagePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSandTransmitErrorMessageRange() Return the range specification for this field
java.lang.String	getSandTransmitErrorMessageValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getSandTransmitStatus() Accessor for sandTransmitStatus
static int	getSandTransmitStatusDefaultValue() Default value for sandTransmitStatus.
java.lang.String	getSandTransmitStatusFieldPrintValue() Return the print name of the sandTransmitStatus field.
static boolean	getSandTransmitStatusFlag(int fieldflag) Field flag accessor.
static int	getSandTransmitStatusInvalidValue() Invalid value for sandTransmitStatus.
java.lang.String	getSandTransmitStatusMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSandTransmitStatusPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSandTransmitStatusRange() Return the range specification for this field
java.lang.String	getSandTransmitStatusValidityCheck() 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.
java.lang.String	getSource() Generalized accessor for the source
org.sandev.basics.structs.SandStructMessage	getStructMessage() Returns a new Plan instance
org.sandev.basics.structs.SandUpdateMessage	getUpdateMessage() Returns a new PlanUpdate instance
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.
void	setAction(int action) Mutator for action
void	setInstance(org.sandev.basics.structs.SandStructMessage msg) Generalized mutator for the update instance
void	setPlan(java.lang.Object plan) Generic mutator for plan
void	setPlan(Plan plan) Mutator for plan
void	setSandTransmissionCount(int sandTransmissionCount) Mutator for sandTransmissionCount
void	setSandTransmitAuthID(long sandTransmitAuthID) Mutator for sandTransmitAuthID
void	setSandTransmitErrorMessage(java.lang.Object sandTransmitErrorMessage) Generic mutator for sandTransmitErrorMessage
void	setSandTransmitErrorMessage(java.lang.String sandTransmitErrorMessage) Mutator for sandTransmitErrorMessage
void	setSandTransmitStatus(int sandTransmitStatus) Mutator for sandTransmitStatus
void	setSource(java.lang.String val) Generalized mutator for the source

Methods inherited from class java.lang.Object

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

Field Detail

sandTransmitAuthID

protected long sandTransmitAuthID

support for SandTransmitMessage interface

sandTransmitErrorMessage

protected java.lang.String sandTransmitErrorMessage

support for SandTransmitMessage interface

sandTransmitStatus

protected int sandTransmitStatus

support for SandTransmitMessage interface

sandTransmissionCount

protected int sandTransmissionCount

support for SandTransmitMessage interface

action

protected int action

support for SandUpdateMessage interface

ACTION_UNKNOWN

public static final int ACTION_UNKNOWN

Possible value for action

See Also:

Constant Field Values

ACTION_ADDING

public static final int ACTION_ADDING

Possible value for action

See Also:

Constant Field Values

ACTION_UPDATING

public static final int ACTION_UPDATING

Possible value for action

See Also:

Constant Field Values

ACTION_DELETING

public static final int ACTION_DELETING

Possible value for action

See Also:

Constant Field Values

plan

protected Plan plan

the contained instance for this update

source

protected java.lang.String source

The source of this update

Constructor Detail

PlanUpdate

public PlanUpdate()

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.

getSandTransmitAuthID

public long getSandTransmitAuthID()

Accessor for sandTransmitAuthID

Specified by:

getSandTransmitAuthID in interface org.sandev.basics.structs.SandTransmitMessage

setSandTransmitAuthID

public void setSandTransmitAuthID(long sandTransmitAuthID)

Mutator for sandTransmitAuthID

Specified by:

setSandTransmitAuthID in interface org.sandev.basics.structs.SandTransmitMessage

getSandTransmitAuthIDFlag

public static boolean getSandTransmitAuthIDFlag(int fieldflag)

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

getSandTransmitAuthIDDefaultValue

public static long getSandTransmitAuthIDDefaultValue()

Default value for sandTransmitAuthID. Returns 0

getSandTransmitAuthIDInvalidValue

public static long getSandTransmitAuthIDInvalidValue()

Invalid value for sandTransmitAuthID. Returns Long.MIN_VALUE

getSandTransmitAuthIDPrintValue

public java.lang.String getSandTransmitAuthIDPrintValue()

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.

getSandTransmitAuthIDFieldPrintValue

public java.lang.String getSandTransmitAuthIDFieldPrintValue()

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

getSandTransmitAuthIDRange

public java.lang.String getSandTransmitAuthIDRange()

Return the range specification for this field

getSandTransmitAuthIDValidityCheck

public java.lang.String getSandTransmitAuthIDValidityCheck()

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.

getSandTransmitAuthIDMetatype

public java.lang.String getSandTransmitAuthIDMetatype()

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

getSandTransmitErrorMessage

public java.lang.String getSandTransmitErrorMessage()

Accessor for sandTransmitErrorMessage

Specified by:

getSandTransmitErrorMessage in interface org.sandev.basics.structs.SandTransmitMessage

setSandTransmitErrorMessage

public void setSandTransmitErrorMessage(java.lang.String sandTransmitErrorMessage)

Mutator for sandTransmitErrorMessage

Specified by:

setSandTransmitErrorMessage in interface org.sandev.basics.structs.SandTransmitMessage

setSandTransmitErrorMessage

public void setSandTransmitErrorMessage(java.lang.Object sandTransmitErrorMessage)

Generic mutator for sandTransmitErrorMessage

getSandTransmitErrorMessageFlag

public static boolean getSandTransmitErrorMessageFlag(int fieldflag)

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

getSandTransmitErrorMessageLengthNorm

public static int getSandTransmitErrorMessageLengthNorm()

Normal sandTransmitErrorMessage length is 30 characters

getSandTransmitErrorMessageLengthMax

public static int getSandTransmitErrorMessageLengthMax()

Maximum sandTransmitErrorMessage length is 70 characters

getSandTransmitErrorMessageDefaultValue

public static java.lang.String getSandTransmitErrorMessageDefaultValue()

Default value for sandTransmitErrorMessage. Returns ""

getSandTransmitErrorMessageInvalidValue

public static java.lang.String getSandTransmitErrorMessageInvalidValue()

Invalid value for sandTransmitErrorMessage. Returns null

getSandTransmitErrorMessagePrintValue

public java.lang.String getSandTransmitErrorMessagePrintValue()

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.

getSandTransmitErrorMessageFieldPrintValue

public java.lang.String getSandTransmitErrorMessageFieldPrintValue()

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

getSandTransmitErrorMessageRange

public java.lang.String getSandTransmitErrorMessageRange()

Return the range specification for this field

getSandTransmitErrorMessageValidityCheck

public java.lang.String getSandTransmitErrorMessageValidityCheck()

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.

getSandTransmitErrorMessageMetatype

public java.lang.String getSandTransmitErrorMessageMetatype()

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

getSandTransmitStatus

public int getSandTransmitStatus()

Accessor for sandTransmitStatus

Specified by:

getSandTransmitStatus in interface org.sandev.basics.structs.SandTransmitMessage

setSandTransmitStatus

public void setSandTransmitStatus(int sandTransmitStatus)

Mutator for sandTransmitStatus

Specified by:

setSandTransmitStatus in interface org.sandev.basics.structs.SandTransmitMessage

getSandTransmitStatusFlag

public static boolean getSandTransmitStatusFlag(int fieldflag)

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

getSandTransmitStatusDefaultValue

public static int getSandTransmitStatusDefaultValue()

Default value for sandTransmitStatus. Returns 0

getSandTransmitStatusInvalidValue

public static int getSandTransmitStatusInvalidValue()

Invalid value for sandTransmitStatus. Returns Integer.MIN_VALUE

getSandTransmitStatusPrintValue

public java.lang.String getSandTransmitStatusPrintValue()

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.

getSandTransmitStatusFieldPrintValue

public java.lang.String getSandTransmitStatusFieldPrintValue()

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

getSandTransmitStatusRange

public java.lang.String getSandTransmitStatusRange()

Return the range specification for this field

getSandTransmitStatusValidityCheck

public java.lang.String getSandTransmitStatusValidityCheck()

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.

getSandTransmitStatusMetatype

public java.lang.String getSandTransmitStatusMetatype()

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

getSandTransmissionCount

public int getSandTransmissionCount()

Accessor for sandTransmissionCount

Specified by:

getSandTransmissionCount in interface org.sandev.basics.structs.SandTransmitMessage

setSandTransmissionCount

public void setSandTransmissionCount(int sandTransmissionCount)

Mutator for sandTransmissionCount

Specified by:

setSandTransmissionCount in interface org.sandev.basics.structs.SandTransmitMessage

getSandTransmissionCountFlag

public static boolean getSandTransmissionCountFlag(int fieldflag)

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

getSandTransmissionCountDefaultValue

public static int getSandTransmissionCountDefaultValue()

Default value for sandTransmissionCount. Returns 0

getSandTransmissionCountInvalidValue

public static int getSandTransmissionCountInvalidValue()

Invalid value for sandTransmissionCount. Returns Integer.MIN_VALUE

getSandTransmissionCountPrintValue

public java.lang.String getSandTransmissionCountPrintValue()

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.

getSandTransmissionCountFieldPrintValue

public java.lang.String getSandTransmissionCountFieldPrintValue()

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

getSandTransmissionCountRange

public java.lang.String getSandTransmissionCountRange()

Return the range specification for this field

getSandTransmissionCountValidityCheck

public java.lang.String getSandTransmissionCountValidityCheck()

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.

getSandTransmissionCountMetatype

public java.lang.String getSandTransmissionCountMetatype()

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

getAction

public int getAction()

Accessor for action

Specified by:

getAction in interface org.sandev.basics.structs.SandUpdateMessage

setAction

public void setAction(int action)

Mutator for action

Specified by:

setAction in interface org.sandev.basics.structs.SandUpdateMessage

actionValueToLabel

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

Specified by:

actionValueToLabel in interface org.sandev.basics.structs.SandUpdateMessage

actionLabelToValue

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

getActionPrintVals

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

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.

getActionKeyVals

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

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.

getActionActualVals

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

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

actionPrint2Key

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

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

actionPrint2Actual

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

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

actionActual2Print

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

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

getActionEnumSummary

public static java.lang.String getActionEnumSummary()

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

getActionFlag

public static boolean getActionFlag(int fieldflag)

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

getActionDefaultValue

public static int getActionDefaultValue()

Default value for action. Returns 0

getActionInvalidValue

public static int getActionInvalidValue()

Invalid value for action. Returns Integer.MIN_VALUE

getActionPrintValue

public java.lang.String getActionPrintValue()

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.

getActionFieldPrintValue

public java.lang.String getActionFieldPrintValue()

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

getActionRange

public java.lang.String getActionRange()

Return the range specification for this field

getActionValidityCheck

public java.lang.String getActionValidityCheck()

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.

getActionMetatype

public java.lang.String getActionMetatype()

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

getPlan

public Plan getPlan()

Accessor for plan

setPlan

public void setPlan(Plan plan)

Mutator for plan

setPlan

public void setPlan(java.lang.Object plan)

Generic mutator for plan

getPlanFlag

public static boolean getPlanFlag(int fieldflag)

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

getPlanDefaultValue

public static Plan getPlanDefaultValue()

Default value for plan. Returns null

getPlanInvalidValue

public static Plan getPlanInvalidValue()

Invalid value for plan. Returns null

getPlanPrintValue

public java.lang.String getPlanPrintValue()

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.

getPlanFieldPrintValue

public java.lang.String getPlanFieldPrintValue()

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

getPlanRange

public java.lang.String getPlanRange()

Return the range specification for this field

getPlanValidityCheck

public java.lang.String getPlanValidityCheck()

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.

getPlanMetatype

public java.lang.String getPlanMetatype()

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

init

public void init()

Initialize all fields to their default values

getInstance

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

Generalized accessor for the update instance

Specified by:

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

setInstance

public void setInstance(org.sandev.basics.structs.SandStructMessage msg)

Generalized mutator for the update instance

Specified by:

setInstance in interface org.sandev.basics.structs.SandUpdateMessage

getInstanceID

public long getInstanceID()

Return the uniqueID of the update instance, or -1 if it is not a persistent message.

Specified by:

getInstanceID in interface org.sandev.basics.structs.SandUpdateMessage

getSource

public java.lang.String getSource()

Generalized accessor for the source

Specified by:

getSource in interface org.sandev.basics.structs.SandUpdateMessage

setSource

public void setSource(java.lang.String val)

Generalized mutator for the source

Specified by:

setSource in interface org.sandev.basics.structs.SandUpdateMessage

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

Specified by:

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

getCollectionMessage

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

Returns a new PlanCollection instance

Specified by:

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

getUpdateMessage

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

Returns a new PlanUpdate instance

Specified by:

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

getStructMessage

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

Returns a new Plan 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