org.sandev.TaskHeap.sandmessages
Class PlanComponentReport

java.lang.Object
  org.sandev.TaskHeap.structs.PlanComponentReportStruct
      org.sandev.TaskHeap.sandmessages.PlanComponentReport

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

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

Field Summary

static int	COMPONENTTYPE_EXTERNALPLAN Possible value for componentType
static int	COMPONENTTYPE_PLAN Possible value for componentType
static int	COMPONENTTYPE_TASK Possible value for componentType
static int	COMPONENTTYPE_UNKNOWN Possible value for componentType

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

componentType, description, name, notes, phase, sourceComponent

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

PlanComponentReport()
Default constructor calls init.

Method Summary

org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls clonePlanComponentReport
PlanComponentReport	clonePlanComponentReport() Make a deep copy of this PlanComponentReport.
static java.lang.String	componentTypeActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	componentTypeLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	componentTypeLabelToValueStatic(java.lang.String label)
static java.lang.String	componentTypePrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	componentTypePrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	componentTypeValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	componentTypeValueToLabelStatic(int val)
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(PlanComponentReport other, boolean deepcopy) Copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.SandInstanceMessage other) Copy the specified field from the given instance.
java.lang.String	debugDump(java.lang.String prefix) Dump this instance into a debug printable string.
void	defaultField(java.lang.String fieldname) Set the specified field to its default value.
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
boolean	fieldsValid() Validate the fields as specified in the SandInstanceMessage interface
org.sandev.basics.structs.SandAttrVal[]	fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
org.sandev.basics.structs.SandCollectionMessage	find(org.sandev.basics.structs.SandQueryMessage sqm) Return a matching collection of all directly contained instances matching the given query.
java.lang.Object	generalAccessor(java.lang.String fieldspec) General field accessor method.
org.sandev.basics.structs.SandAttrVal	generalDereference(java.lang.String fieldspec) General reference field accessor method.
void	generalModifier(int action, java.lang.String field, int index, java.lang.Object val) General mutator method.
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
int	getComponentType() Accessor for componentType
static java.lang.String[]	getComponentTypeActualVals() Return an array of the possible values for this field as Strings.
static int	getComponentTypeDefaultValue() Default value for componentType.
static java.lang.String	getComponentTypeEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getComponentTypeFieldPrintValue() Return the print name of the componentType field.
static boolean	getComponentTypeFlag(int fieldflag) Field flag accessor.
static int	getComponentTypeInvalidValue() Invalid value for componentType.
static java.lang.String[]	getComponentTypeKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getComponentTypeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getComponentTypePrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getComponentTypePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getComponentTypeRange() Return the range specification for this field
java.lang.String	getComponentTypeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String[]	getContainedMessageFields() Return an array of all contained message fields.
java.lang.String	getDescription() Accessor for description
static java.lang.String	getDescriptionDefaultValue() Default value for description.
java.lang.String	getDescriptionFieldPrintValue() Return the print name of the description field.
static boolean	getDescriptionFlag(int fieldflag) Field flag accessor.
static java.lang.String	getDescriptionInvalidValue() Invalid value for description.
static int	getDescriptionLengthMax() Maximum description length is 4096 characters
static int	getDescriptionLengthNorm() Normal description length is 255 characters
java.lang.String	getDescriptionMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getDescriptionPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getDescriptionRange() Return the range specification for this field
java.lang.String	getDescriptionValidityCheck() 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	getName() Accessor for name
static java.lang.String	getNameDefaultValue() Default value for name.
java.lang.String	getNameFieldPrintValue() Return the print name of the name field.
static boolean	getNameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getNameInvalidValue() Invalid value for name.
static int	getNameLengthMax() Maximum name length is 128 characters
static int	getNameLengthNorm() Normal name length is 60 characters
java.lang.String	getNameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getNamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getNameRange() Return the range specification for this field
java.lang.String	getNameValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getNotes() Accessor for notes
static java.lang.String	getNotesDefaultValue() Default value for notes.
java.lang.String	getNotesFieldPrintValue() Return the print name of the notes field.
static boolean	getNotesFlag(int fieldflag) Field flag accessor.
static java.lang.String	getNotesInvalidValue() Invalid value for notes.
static int	getNotesLengthMax() Maximum notes length is 1048576 characters
static int	getNotesLengthNorm() Normal notes length is 2048 characters
java.lang.String	getNotesMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getNotesPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getNotesRange() Return the range specification for this field
java.lang.String	getNotesValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
long	getPhase() Accessor for phase
static long	getPhaseDefaultValue() Default value for phase.
java.lang.String	getPhaseFieldPrintValue() Return the print name of the phase field.
static boolean	getPhaseFlag(int fieldflag) Field flag accessor.
static long	getPhaseInvalidValue() Invalid value for phase.
java.lang.String	getPhaseMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getPhasePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getPhaseRange() Return the range specification for this field
java.lang.String	getPhaseValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getPrintname() Return the printname of the class
java.lang.String	getPrintnameForField(java.lang.String fieldname) Given a fieldname, return its declared printname if declared.
org.sandev.basics.structs.SandQueryMessage	getQueryMessage() Returns null
java.lang.String	getShortName() Returns the unqualified name of this message.
PlanComponentInterface	getSourceComponent() Accessor for sourceComponent
static PlanComponent	getSourceComponentDefaultValue() Default value for sourceComponent.
java.lang.String	getSourceComponentFieldPrintValue() Return the print name of the sourceComponent field.
static boolean	getSourceComponentFlag(int fieldflag) Field flag accessor.
static PlanComponent	getSourceComponentInvalidValue() Invalid value for sourceComponent.
java.lang.String	getSourceComponentMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSourceComponentPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSourceComponentRange() Return the range specification for this field
java.lang.String	getSourceComponentValidityCheck() 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 PlanComponentReport instance
org.sandev.basics.structs.SandUpdateMessage	getUpdateMessage() Returns a new PlanComponentReportUpdate instance
java.lang.String	getValueForFieldName(java.lang.String fieldname, org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Returns the print representation of the value of the specified field, or the given default value if innaccessible.
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.
TaskPhase	resolvePhaseReference(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Converts a reference to an instance by looking it up.
TaskPhase	resolvePhaseReferenceNonCrit(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	setComponentType(int componentType) Mutator for componentType
void	setDescription(java.lang.Object description) Generic mutator for description
void	setDescription(java.lang.String description) Mutator for description
void	setName(java.lang.Object name) Generic mutator for name
void	setName(java.lang.String name) Mutator for name
void	setNotes(java.lang.Object notes) Generic mutator for notes
void	setNotes(java.lang.String notes) Mutator for notes
void	setPhase(long phase) Mutator for phase
void	setSourceComponent(java.lang.Object sourceComponent) Generic mutator for sourceComponent
void	setSourceComponent(PlanComponentInterface sourceComponent) Mutator for sourceComponent
PlanComponentReport	shallowCopy() Make a shallow copy of this PlanComponentReport.
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

COMPONENTTYPE_UNKNOWN

public static final int COMPONENTTYPE_UNKNOWN

Possible value for componentType

See Also:

Constant Field Values

COMPONENTTYPE_TASK

public static final int COMPONENTTYPE_TASK

Possible value for componentType

See Also:

Constant Field Values

COMPONENTTYPE_PLAN

public static final int COMPONENTTYPE_PLAN

Possible value for componentType

See Also:

Constant Field Values

COMPONENTTYPE_EXTERNALPLAN

public static final int COMPONENTTYPE_EXTERNALPLAN

Possible value for componentType

See Also:

Constant Field Values

Constructor Detail

PlanComponentReport

public PlanComponentReport()

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

getName

public java.lang.String getName()

Accessor for name

setName

public void setName(java.lang.String name)

Mutator for name

setName

public void setName(java.lang.Object name)

Generic mutator for name

getNameFlag

public static boolean getNameFlag(int fieldflag)

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

getNameLengthNorm

public static int getNameLengthNorm()

Normal name length is 60 characters

getNameLengthMax

public static int getNameLengthMax()

Maximum name length is 128 characters

getNameDefaultValue

public static java.lang.String getNameDefaultValue()

Default value for name. Returns ""

getNameInvalidValue

public static java.lang.String getNameInvalidValue()

Invalid value for name. Returns "TASKHEAP_INVALID_NAME"

getNamePrintValue

public java.lang.String getNamePrintValue()

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

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

getNameFieldPrintValue

public java.lang.String getNameFieldPrintValue()

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

getNameRange

public java.lang.String getNameRange()

Return the range specification for this field

getNameValidityCheck

public java.lang.String getNameValidityCheck()

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

getNameMetatype

public java.lang.String getNameMetatype()

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

getDescription

public java.lang.String getDescription()

Accessor for description

setDescription

public void setDescription(java.lang.String description)

Mutator for description

setDescription

public void setDescription(java.lang.Object description)

Generic mutator for description

getDescriptionFlag

public static boolean getDescriptionFlag(int fieldflag)

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

getDescriptionLengthNorm

public static int getDescriptionLengthNorm()

Normal description length is 255 characters

getDescriptionLengthMax

public static int getDescriptionLengthMax()

Maximum description length is 4096 characters

getDescriptionDefaultValue

public static java.lang.String getDescriptionDefaultValue()

Default value for description. Returns ""

getDescriptionInvalidValue

public static java.lang.String getDescriptionInvalidValue()

Invalid value for description. Returns "TASKHEAP_INVALID_DESCRIPTIONTEXT"

getDescriptionPrintValue

public java.lang.String getDescriptionPrintValue()

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.

getDescriptionFieldPrintValue

public java.lang.String getDescriptionFieldPrintValue()

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

getDescriptionRange

public java.lang.String getDescriptionRange()

Return the range specification for this field

getDescriptionValidityCheck

public java.lang.String getDescriptionValidityCheck()

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.

getDescriptionMetatype

public java.lang.String getDescriptionMetatype()

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

getPhase

public long getPhase()

Accessor for phase

setPhase

public void setPhase(long phase)

Mutator for phase

getPhaseFlag

public static boolean getPhaseFlag(int fieldflag)

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

getPhaseDefaultValue

public static long getPhaseDefaultValue()

Default value for phase. Returns 0

getPhaseInvalidValue

public static long getPhaseInvalidValue()

Invalid value for phase. Returns Long.MIN_VALUE

getPhasePrintValue

public java.lang.String getPhasePrintValue()

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.

getPhaseFieldPrintValue

public java.lang.String getPhaseFieldPrintValue()

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

getPhaseRange

public java.lang.String getPhaseRange()

Return the range specification for this field

resolvePhaseReferenceNonCrit

public TaskPhase resolvePhaseReferenceNonCrit(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).

resolvePhaseReference

public TaskPhase resolvePhaseReference(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

getPhaseValidityCheck

public java.lang.String getPhaseValidityCheck()

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.

getPhaseMetatype

public java.lang.String getPhaseMetatype()

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

getNotes

public java.lang.String getNotes()

Accessor for notes

setNotes

public void setNotes(java.lang.String notes)

Mutator for notes

setNotes

public void setNotes(java.lang.Object notes)

Generic mutator for notes

getNotesFlag

public static boolean getNotesFlag(int fieldflag)

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

getNotesLengthNorm

public static int getNotesLengthNorm()

Normal notes length is 2048 characters

getNotesLengthMax

public static int getNotesLengthMax()

Maximum notes length is 1048576 characters

getNotesDefaultValue

public static java.lang.String getNotesDefaultValue()

Default value for notes. Returns ""

getNotesInvalidValue

public static java.lang.String getNotesInvalidValue()

Invalid value for notes. Returns "TASKHEAP_INVALID_REPORTTEXT"

getNotesPrintValue

public java.lang.String getNotesPrintValue()

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.

getNotesFieldPrintValue

public java.lang.String getNotesFieldPrintValue()

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

getNotesRange

public java.lang.String getNotesRange()

Return the range specification for this field

getNotesValidityCheck

public java.lang.String getNotesValidityCheck()

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.

getNotesMetatype

public java.lang.String getNotesMetatype()

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

getComponentType

public int getComponentType()

Accessor for componentType

setComponentType

public void setComponentType(int componentType)

Mutator for componentType

componentTypeValueToLabel

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

componentTypeValueToLabelStatic

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

componentTypeLabelToValue

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

componentTypeLabelToValueStatic

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

getComponentTypePrintVals

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

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.

getComponentTypeKeyVals

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

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.

getComponentTypeActualVals

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

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

componentTypePrint2Key

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

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

componentTypePrint2Actual

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

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

componentTypeActual2Print

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

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

getComponentTypeEnumSummary

public static java.lang.String getComponentTypeEnumSummary()

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

getComponentTypeFlag

public static boolean getComponentTypeFlag(int fieldflag)

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

getComponentTypeDefaultValue

public static int getComponentTypeDefaultValue()

Default value for componentType. Returns COMPONENTTYPE_UNKNOWN

getComponentTypeInvalidValue

public static int getComponentTypeInvalidValue()

Invalid value for componentType. Returns -1

getComponentTypePrintValue

public java.lang.String getComponentTypePrintValue()

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.

getComponentTypeFieldPrintValue

public java.lang.String getComponentTypeFieldPrintValue()

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

getComponentTypeRange

public java.lang.String getComponentTypeRange()

Return the range specification for this field

getComponentTypeValidityCheck

public java.lang.String getComponentTypeValidityCheck()

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.

getComponentTypeMetatype

public java.lang.String getComponentTypeMetatype()

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

getSourceComponent

public PlanComponentInterface getSourceComponent()

Accessor for sourceComponent

setSourceComponent

public void setSourceComponent(PlanComponentInterface sourceComponent)

Mutator for sourceComponent

setSourceComponent

public void setSourceComponent(java.lang.Object sourceComponent)

Generic mutator for sourceComponent

getSourceComponentFlag

public static boolean getSourceComponentFlag(int fieldflag)

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

getSourceComponentDefaultValue

public static PlanComponent getSourceComponentDefaultValue()

Default value for sourceComponent. Returns null

getSourceComponentInvalidValue

public static PlanComponent getSourceComponentInvalidValue()

Invalid value for sourceComponent. Returns null

getSourceComponentPrintValue

public java.lang.String getSourceComponentPrintValue()

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.

getSourceComponentFieldPrintValue

public java.lang.String getSourceComponentFieldPrintValue()

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

getSourceComponentRange

public java.lang.String getSourceComponentRange()

Return the range specification for this field

getSourceComponentValidityCheck

public java.lang.String getSourceComponentValidityCheck()

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.

getSourceComponentMetatype

public java.lang.String getSourceComponentMetatype()

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

init

public void init()

Initialize all fields to their default values

getShortName

public java.lang.String getShortName()

Returns the unqualified name of this message.

Specified by:

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

getQueryMessage

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

Returns null

Specified by:

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

getCollectionMessage

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

Returns null

Specified by:

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

getUpdateMessage

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

Returns a new PlanComponentReportUpdate instance

Specified by:

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

getStructMessage

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

Returns a new PlanComponentReport 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 clonePlanComponentReport

Specified by:

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

clonePlanComponentReport

public PlanComponentReport clonePlanComponentReport()

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

shallowCopy

public PlanComponentReport shallowCopy()

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

copyDataFrom

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