org.sandev.TaskHeap.sandmessages
Class RelativeDeadline

java.lang.Object
  org.sandev.TaskHeap.structs.RelativeDeadlineStruct
      org.sandev.TaskHeap.sandmessages.RelativeDeadline

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 RelativeDeadline
extends RelativeDeadlineStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.structs.RelativeDeadlineStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jul 31, 2008 4:34:16 PM

Field Summary

static int	DELTATIMEUNITS_DAYS Possible value for deltaTimeUnits
static int	DELTATIMEUNITS_HOURS Possible value for deltaTimeUnits
static int	DELTATIMEUNITS_WEEKS Possible value for deltaTimeUnits
static int	ROUNDDAY_FRIDAY Possible value for roundDay
static int	ROUNDDAY_MONDAY Possible value for roundDay
static int	ROUNDDAY_SATURDAY Possible value for roundDay
static int	ROUNDDAY_SUNDAY Possible value for roundDay
static int	ROUNDDAY_THURSDAY Possible value for roundDay
static int	ROUNDDAY_TUESDAY Possible value for roundDay
static int	ROUNDDAY_WEDNESDAY Possible value for roundDay
static int	ROUNDING_EXACT Possible value for rounding
static int	ROUNDING_FOLLOWING Possible value for rounding
static int	ROUNDING_MIDMONTH Possible value for rounding
static int	ROUNDING_NEAREST Possible value for rounding
static int	ROUNDING_PRECEDING Possible value for rounding

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

delta, deltaTimeUnits, reference, roundDay, rounding

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

RelativeDeadline()
Default constructor calls init.

Method Summary

org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls cloneRelativeDeadline
RelativeDeadline	cloneRelativeDeadline() Make a deep copy of this RelativeDeadline.
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(RelativeDeadline 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.
static java.lang.String	deltaTimeUnitsActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	deltaTimeUnitsLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	deltaTimeUnitsLabelToValueStatic(java.lang.String label)
static java.lang.String	deltaTimeUnitsPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	deltaTimeUnitsPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	deltaTimeUnitsValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	deltaTimeUnitsValueToLabelStatic(int val)
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
boolean	fieldsValid() Validate the fields as specified in the SandInstanceMessage interface
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.
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[]	getContainedMessageFields() Return an array of all contained message fields.
int	getDelta() Accessor for delta
static int	getDeltaDefaultValue() Default value for delta.
java.lang.String	getDeltaFieldPrintValue() Return the print name of the delta field.
static boolean	getDeltaFlag(int fieldflag) Field flag accessor.
static int	getDeltaInvalidValue() Invalid value for delta.
java.lang.String	getDeltaMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getDeltaPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDeltaRange() Return the range specification for this field
int	getDeltaTimeUnits() Accessor for deltaTimeUnits
static java.lang.String[]	getDeltaTimeUnitsActualVals() Return an array of the possible values for this field as Strings.
static int	getDeltaTimeUnitsDefaultValue() Default value for deltaTimeUnits.
static java.lang.String	getDeltaTimeUnitsEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getDeltaTimeUnitsFieldPrintValue() Return the print name of the deltaTimeUnits field.
static boolean	getDeltaTimeUnitsFlag(int fieldflag) Field flag accessor.
static int	getDeltaTimeUnitsInvalidValue() Invalid value for deltaTimeUnits.
static java.lang.String[]	getDeltaTimeUnitsKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getDeltaTimeUnitsMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getDeltaTimeUnitsPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getDeltaTimeUnitsPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDeltaTimeUnitsRange() Return the range specification for this field
java.lang.String	getDeltaTimeUnitsValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getDeltaValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String[]	getDisplayFields() Return an array of the summary field names for this class.
java.lang.String[]	getDisplayFieldsPrint() Return an array of the summary field print names for this class.
java.lang.String	getDisplayID() Return the displayID for this message instance
java.lang.String[]	getDisplayValues() Return the values for the summary fields.
java.lang.String[]	getDisplayValues(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	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
long	getReference() Accessor for reference
static long	getReferenceDefaultValue() Default value for reference.
java.lang.String	getReferenceFieldPrintValue() Return the print name of the reference field.
static boolean	getReferenceFlag(int fieldflag) Field flag accessor.
static long	getReferenceInvalidValue() Invalid value for reference.
java.lang.String	getReferenceMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getReferencePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getReferenceRange() Return the range specification for this field
java.lang.String	getReferenceValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getRoundDay() Accessor for roundDay
static java.lang.String[]	getRoundDayActualVals() Return an array of the possible values for this field as Strings.
static int	getRoundDayDefaultValue() Default value for roundDay.
static java.lang.String	getRoundDayEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getRoundDayFieldPrintValue() Return the print name of the roundDay field.
static boolean	getRoundDayFlag(int fieldflag) Field flag accessor.
static int	getRoundDayInvalidValue() Invalid value for roundDay.
static java.lang.String[]	getRoundDayKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getRoundDayMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getRoundDayPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getRoundDayPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getRoundDayRange() Return the range specification for this field
java.lang.String	getRoundDayValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getRounding() Accessor for rounding
static java.lang.String[]	getRoundingActualVals() Return an array of the possible values for this field as Strings.
static int	getRoundingDefaultValue() Default value for rounding.
static java.lang.String	getRoundingEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getRoundingFieldPrintValue() Return the print name of the rounding field.
static boolean	getRoundingFlag(int fieldflag) Field flag accessor.
static int	getRoundingInvalidValue() Invalid value for rounding.
static java.lang.String[]	getRoundingKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getRoundingMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getRoundingPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getRoundingPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getRoundingRange() Return the range specification for this field
java.lang.String	getRoundingValidityCheck() 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 RelativeDeadline 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.
static java.lang.String	roundDayActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	roundDayLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	roundDayLabelToValueStatic(java.lang.String label)
static java.lang.String	roundDayPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	roundDayPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	roundDayValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	roundDayValueToLabelStatic(int val)
static java.lang.String	roundingActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	roundingLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	roundingLabelToValueStatic(java.lang.String label)
static java.lang.String	roundingPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	roundingPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	roundingValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	roundingValueToLabelStatic(int val)
void	setDelta(int delta) Mutator for delta
void	setDeltaTimeUnits(int deltaTimeUnits) Mutator for deltaTimeUnits
void	setReference(long reference) Mutator for reference
void	setRoundDay(int roundDay) Mutator for roundDay
void	setRounding(int rounding) Mutator for rounding
RelativeDeadline	shallowCopy() Make a shallow copy of this RelativeDeadline.
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

DELTATIMEUNITS_HOURS

public static final int DELTATIMEUNITS_HOURS

Possible value for deltaTimeUnits

See Also:

Constant Field Values

DELTATIMEUNITS_DAYS

public static final int DELTATIMEUNITS_DAYS

Possible value for deltaTimeUnits

See Also:

Constant Field Values

DELTATIMEUNITS_WEEKS

public static final int DELTATIMEUNITS_WEEKS

Possible value for deltaTimeUnits

See Also:

Constant Field Values

ROUNDING_EXACT

public static final int ROUNDING_EXACT

Possible value for rounding

See Also:

Constant Field Values

ROUNDING_NEAREST

public static final int ROUNDING_NEAREST

Possible value for rounding

See Also:

Constant Field Values

ROUNDING_PRECEDING

public static final int ROUNDING_PRECEDING

Possible value for rounding

See Also:

Constant Field Values

ROUNDING_FOLLOWING

public static final int ROUNDING_FOLLOWING

Possible value for rounding

See Also:

Constant Field Values

ROUNDING_MIDMONTH

public static final int ROUNDING_MIDMONTH

Possible value for rounding

See Also:

Constant Field Values

ROUNDDAY_MONDAY

public static final int ROUNDDAY_MONDAY

Possible value for roundDay

See Also:

Constant Field Values

ROUNDDAY_TUESDAY

public static final int ROUNDDAY_TUESDAY

Possible value for roundDay

See Also:

Constant Field Values

ROUNDDAY_WEDNESDAY

public static final int ROUNDDAY_WEDNESDAY

Possible value for roundDay

See Also:

Constant Field Values

ROUNDDAY_THURSDAY

public static final int ROUNDDAY_THURSDAY

Possible value for roundDay

See Also:

Constant Field Values

ROUNDDAY_FRIDAY

public static final int ROUNDDAY_FRIDAY

Possible value for roundDay

See Also:

Constant Field Values

ROUNDDAY_SATURDAY

public static final int ROUNDDAY_SATURDAY

Possible value for roundDay

See Also:

Constant Field Values

ROUNDDAY_SUNDAY

public static final int ROUNDDAY_SUNDAY

Possible value for roundDay

See Also:

Constant Field Values

Constructor Detail

RelativeDeadline

public RelativeDeadline()

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

getReference

public long getReference()

Accessor for reference

setReference

public void setReference(long reference)

Mutator for reference

getReferenceFlag

public static boolean getReferenceFlag(int fieldflag)

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

getReferenceDefaultValue

public static long getReferenceDefaultValue()

Default value for reference. Returns 0

getReferenceInvalidValue

public static long getReferenceInvalidValue()

Invalid value for reference. Returns Long.MIN_VALUE

getReferencePrintValue

public java.lang.String getReferencePrintValue()

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.

getReferenceFieldPrintValue

public java.lang.String getReferenceFieldPrintValue()

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

getReferenceRange

public java.lang.String getReferenceRange()

Return the range specification for this field

getReferenceValidityCheck

public java.lang.String getReferenceValidityCheck()

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.

getReferenceMetatype

public java.lang.String getReferenceMetatype()

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

getDelta

public int getDelta()

Accessor for delta

setDelta

public void setDelta(int delta)

Mutator for delta

getDeltaFlag

public static boolean getDeltaFlag(int fieldflag)

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

getDeltaDefaultValue

public static int getDeltaDefaultValue()

Default value for delta. Returns 0

getDeltaInvalidValue

public static int getDeltaInvalidValue()

Invalid value for delta. Returns Integer.MIN_VALUE

getDeltaPrintValue

public java.lang.String getDeltaPrintValue()

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.

getDeltaFieldPrintValue

public java.lang.String getDeltaFieldPrintValue()

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

getDeltaRange

public java.lang.String getDeltaRange()

Return the range specification for this field

getDeltaValidityCheck

public java.lang.String getDeltaValidityCheck()

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.

getDeltaMetatype

public java.lang.String getDeltaMetatype()

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

getDeltaTimeUnits

public int getDeltaTimeUnits()

Accessor for deltaTimeUnits

setDeltaTimeUnits

public void setDeltaTimeUnits(int deltaTimeUnits)

Mutator for deltaTimeUnits

deltaTimeUnitsValueToLabel

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

deltaTimeUnitsValueToLabelStatic

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

deltaTimeUnitsLabelToValue

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

deltaTimeUnitsLabelToValueStatic

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

getDeltaTimeUnitsPrintVals

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

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.

getDeltaTimeUnitsKeyVals

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

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.

getDeltaTimeUnitsActualVals

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

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

deltaTimeUnitsPrint2Key

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

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

deltaTimeUnitsPrint2Actual

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

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

deltaTimeUnitsActual2Print

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

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

getDeltaTimeUnitsEnumSummary

public static java.lang.String getDeltaTimeUnitsEnumSummary()

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

getDeltaTimeUnitsFlag

public static boolean getDeltaTimeUnitsFlag(int fieldflag)

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

getDeltaTimeUnitsDefaultValue

public static int getDeltaTimeUnitsDefaultValue()

Default value for deltaTimeUnits. Returns DELTATIMEUNITS_DAYS

getDeltaTimeUnitsInvalidValue

public static int getDeltaTimeUnitsInvalidValue()

Invalid value for deltaTimeUnits. Returns -1

getDeltaTimeUnitsPrintValue

public java.lang.String getDeltaTimeUnitsPrintValue()

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.

getDeltaTimeUnitsFieldPrintValue

public java.lang.String getDeltaTimeUnitsFieldPrintValue()

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

getDeltaTimeUnitsRange

public java.lang.String getDeltaTimeUnitsRange()

Return the range specification for this field

getDeltaTimeUnitsValidityCheck

public java.lang.String getDeltaTimeUnitsValidityCheck()

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.

getDeltaTimeUnitsMetatype

public java.lang.String getDeltaTimeUnitsMetatype()

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

getRounding

public int getRounding()

Accessor for rounding

setRounding

public void setRounding(int rounding)

Mutator for rounding

roundingValueToLabel

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

roundingValueToLabelStatic

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

roundingLabelToValue

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

roundingLabelToValueStatic

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

getRoundingPrintVals

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

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.

getRoundingKeyVals

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

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.

getRoundingActualVals

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

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

roundingPrint2Key

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

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

roundingPrint2Actual

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

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

roundingActual2Print

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

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

getRoundingEnumSummary

public static java.lang.String getRoundingEnumSummary()

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

getRoundingFlag

public static boolean getRoundingFlag(int fieldflag)

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

getRoundingDefaultValue

public static int getRoundingDefaultValue()

Default value for rounding. Returns ROUNDING_NEAREST

getRoundingInvalidValue

public static int getRoundingInvalidValue()

Invalid value for rounding. Returns -1

getRoundingPrintValue

public java.lang.String getRoundingPrintValue()

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.

getRoundingFieldPrintValue

public java.lang.String getRoundingFieldPrintValue()

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

getRoundingRange

public java.lang.String getRoundingRange()

Return the range specification for this field

getRoundingValidityCheck

public java.lang.String getRoundingValidityCheck()

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.

getRoundingMetatype

public java.lang.String getRoundingMetatype()

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

getRoundDay

public int getRoundDay()

Accessor for roundDay

setRoundDay

public void setRoundDay(int roundDay)

Mutator for roundDay

roundDayValueToLabel

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

roundDayValueToLabelStatic

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

roundDayLabelToValue

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

roundDayLabelToValueStatic

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

getRoundDayPrintVals

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

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.

getRoundDayKeyVals

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

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.

getRoundDayActualVals

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

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

roundDayPrint2Key

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

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

roundDayPrint2Actual

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

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

roundDayActual2Print

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

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

getRoundDayEnumSummary

public static java.lang.String getRoundDayEnumSummary()

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

getRoundDayFlag

public static boolean getRoundDayFlag(int fieldflag)

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

getRoundDayDefaultValue

public static int getRoundDayDefaultValue()

Default value for roundDay. Returns ROUNDDAY_MONDAY

getRoundDayInvalidValue

public static int getRoundDayInvalidValue()

Invalid value for roundDay. Returns -1

getRoundDayPrintValue

public java.lang.String getRoundDayPrintValue()

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.

getRoundDayFieldPrintValue

public java.lang.String getRoundDayFieldPrintValue()

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

getRoundDayRange

public java.lang.String getRoundDayRange()

Return the range specification for this field

getRoundDayValidityCheck

public java.lang.String getRoundDayValidityCheck()

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.

getRoundDayMetatype

public java.lang.String getRoundDayMetatype()

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 RelativeDeadline 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 cloneRelativeDeadline

Specified by:

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

cloneRelativeDeadline

public RelativeDeadline cloneRelativeDeadline()

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

shallowCopy

public RelativeDeadline shallowCopy()

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

copyDataFrom

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