org.sandev.TaskHeap.sandmessages
Class PlanReport

java.lang.Object
  org.sandev.TaskHeap.structs.PlanReportStruct
      org.sandev.TaskHeap.sandmessages.PlanReport

All Implemented Interfaces:

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

public class PlanReport

extends PlanReportStruct

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

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

Field Summary

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

reportText, sourcePlan

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

FIELDCHECK_INVALIDVAL, FIELDCHECK_NOTAREF, FIELDCHECK_NOTINRANGE, FIELDCHECK_NULLARRAY, FIELDCHECK_STRINGOVER, FIELDCHECK_UNKNOWNVAL, FIELDFLAG_BINARY, FIELDFLAG_ENCRYPT, FIELDFLAG_INTERNAL, FIELDFLAG_NOECHO, FIELDFLAG_OBFUSCATE, FIELDFLAG_STRINGPERSIST, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET

Constructor Summary

PlanReport()
Default constructor calls init.

Method Summary

org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls clonePlanReport
PlanReport	clonePlanReport() Make a deep copy of this PlanReport.
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(PlanReport other) Deep copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.SandInstanceMessage other) Copy the specified field from the given instance.
java.lang.String	debugDump(java.lang.String prefix) Dump this instance into a debug printable string.
void	defaultField(java.lang.String fieldname) Set the specified field to its default value.
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
boolean	fieldsValid() Validate the fields as specified in the SandInstanceMessage interface
org.sandev.basics.structs.SandAttrVal[]	fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
java.lang.Object	generalAccessor(java.lang.String fieldspec) General field accessor method.
org.sandev.basics.structs.SandAttrVal	generalDereference(java.lang.String fieldspec) General reference field accessor method.
void	generalModifier(int action, java.lang.String field, int index, java.lang.Object val) General mutator method.
java.lang.String[]	getAllFields() Return an array of all fields for this class.
org.sandev.basics.structs.SandCollectionMessage	getCollectionMessage() Returns null
java.lang.String[]	getDisplayFields() Return an array of the summary field names for this class.
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.SandQueryMessage	getQueryMessage() Returns null
java.lang.String	getReportText() Accessor for reportText
static java.lang.String	getReportTextDefaultValue() Default value for reportText.
java.lang.String	getReportTextFieldPrintValue() Return the print name of the reportText field.
static boolean	getReportTextFlag(int fieldflag) Field flag accessor.
static java.lang.String	getReportTextInvalidValue() Invalid value for reportText.
static int	getReportTextLengthMax() Maximum reportText length is 1048576 characters
static int	getReportTextLengthNorm() Normal reportText length is 2048 characters
java.lang.String	getReportTextMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getReportTextPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getReportTextRange() Return the range specification for this field
java.lang.String	getReportTextValidityCheck() 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.
long	getSourcePlan() Accessor for sourcePlan
static long	getSourcePlanDefaultValue() Default value for sourcePlan.
java.lang.String	getSourcePlanFieldPrintValue() Return the print name of the sourcePlan field.
static boolean	getSourcePlanFlag(int fieldflag) Field flag accessor.
static long	getSourcePlanInvalidValue() Invalid value for sourcePlan.
java.lang.String	getSourcePlanMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSourcePlanPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSourcePlanRange() Return the range specification for this field
java.lang.String	getSourcePlanValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.SandStructMessage	getStructMessage() Returns a new PlanReport 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.
Plan	resolveSourcePlanReference(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Converts a reference to an instance by looking it up.
Plan	resolveSourcePlanReferenceNonCrit(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Calls standard method, eating any SandException and returning a new instance uniqueID -1.
void	setReportText(java.lang.Object reportText) Generic mutator for reportText
void	setReportText(java.lang.String reportText) Mutator for reportText
void	setSourcePlan(long sourcePlan) Mutator for sourcePlan
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

Constructor Detail

PlanReport

public PlanReport()

Default constructor calls init.

Method Detail

fieldHasFlag

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

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

Specified by:

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

getSourcePlan

public long getSourcePlan()

Accessor for sourcePlan

setSourcePlan

public void setSourcePlan(long sourcePlan)

Mutator for sourcePlan

getSourcePlanFlag

public static boolean getSourcePlanFlag(int fieldflag)

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

getSourcePlanDefaultValue

public static long getSourcePlanDefaultValue()

Default value for sourcePlan. Returns 0

getSourcePlanInvalidValue

public static long getSourcePlanInvalidValue()

Invalid value for sourcePlan. Returns Long.MIN_VALUE

getSourcePlanPrintValue

public java.lang.String getSourcePlanPrintValue()

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.

getSourcePlanFieldPrintValue

public java.lang.String getSourcePlanFieldPrintValue()

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

getSourcePlanRange

public java.lang.String getSourcePlanRange()

Return the range specification for this field

resolveSourcePlanReferenceNonCrit

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

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

resolveSourcePlanReference

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

Converts a reference to an instance by looking it up.

Throws:

org.sandev.basics.structs.SandException

getSourcePlanValidityCheck

public java.lang.String getSourcePlanValidityCheck()

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.

getSourcePlanMetatype

public java.lang.String getSourcePlanMetatype()

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

getReportText

public java.lang.String getReportText()

Accessor for reportText

setReportText

public void setReportText(java.lang.String reportText)

Mutator for reportText

setReportText

public void setReportText(java.lang.Object reportText)

Generic mutator for reportText

getReportTextFlag

public static boolean getReportTextFlag(int fieldflag)

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

getReportTextLengthNorm

public static int getReportTextLengthNorm()

Normal reportText length is 2048 characters

getReportTextLengthMax

public static int getReportTextLengthMax()

Maximum reportText length is 1048576 characters

getReportTextDefaultValue

public static java.lang.String getReportTextDefaultValue()

Default value for reportText. Returns ""

getReportTextInvalidValue

public static java.lang.String getReportTextInvalidValue()

Invalid value for reportText. Returns "TASKHEAP_INVALID_REPORTTEXT"

getReportTextPrintValue

public java.lang.String getReportTextPrintValue()

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.

getReportTextFieldPrintValue

public java.lang.String getReportTextFieldPrintValue()

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

getReportTextRange

public java.lang.String getReportTextRange()

Return the range specification for this field

getReportTextValidityCheck

public java.lang.String getReportTextValidityCheck()

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.

getReportTextMetatype

public java.lang.String getReportTextMetatype()

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 PlanReport instance

Specified by:

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

isEquivalent

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

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

Specified by:

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

generalModifier

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

General mutator method. Specified by SandInstanceMessage interface.

Specified by:

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

Throws:

org.sandev.basics.structs.SandException

generalDereference

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

General reference field accessor method. Specified by SandInstanceMessage interface.

Specified by:

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

generalAccessor

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

General field accessor method. Specified by SandInstanceMessage interface.

Specified by:

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

getDisplayFields

public java.lang.String[] getDisplayFields()

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

Specified by:

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

getDisplayValues

public java.lang.String[] getDisplayValues()

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

Specified by:

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

getDisplayValues

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

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

Specified by:

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

getValueForFieldName

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

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

toString

public java.lang.String toString()

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

getAllFields

public java.lang.String[] getAllFields()

Return an array of all fields for this class.

Specified by:

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

defaultField

public void defaultField(java.lang.String fieldname)

Set the specified field to its default value.

Specified by:

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

cloneMessage

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

Calls clonePlanReport

Specified by:

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

clonePlanReport

public PlanReport clonePlanReport()

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

copyDataFrom

public void copyDataFrom(PlanReport other)

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

copyFieldValue

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

Copy the specified field from the given instance.

Specified by:

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

fieldValidate

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

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

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

fieldsValid

public boolean fieldsValid()

Validate the fields as specified in the SandInstanceMessage interface

Specified by:

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

referenceValidate

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

Validate the references as specified in the Resolvable interface.

Specified by:

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

Throws:

org.sandev.basics.structs.SandException

convertToSuperstructClass

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

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

Specified by:

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

debugDump

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

Dump this instance into a debug printable string.

Specified by:

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