org.sandev.TaskHeap.structs
Class PlanComponentReportStruct

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

Direct Known Subclasses:

PlanComponentReport

public class PlanComponentReportStruct
extends java.lang.Object

An overview summary of the description and notes for a PlanComponent. This provides an overview of a Task or Plan that focused on the descriptive information, without all the execution details like assignments or time estimates. A PlanComponentReport is shown when clicking on description in the main heap overview.

summary fields: sourceComponent
This message has the following verb forms: update

Field Summary

protected int	componentType The type of component this was sourced from.
protected java.lang.String	description The text description for the component this was generated for.
protected java.lang.String	notes The full note thread summary in XHTML.
protected long	phase The current phase of this Task, as defined by the type.
protected long	sourceComponent The PlanComponent this overview was generated from.

Constructor Summary

PlanComponentReportStruct()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

description

protected java.lang.String description

The text description for the component this was generated for.

declared invalid value: "TASKHEAP_INVALID_DESCRIPTIONTEXT"
Length in characters, normal: 255 max: 4096
help text: The text description for the component this was generated for.

phase

protected long phase

The current phase of this Task, as defined by the type. For a Plan this is zero.

a dynamic selection display may be generated for this field.
reference to class: org.sandev.TaskHeap.structs.TaskPhaseStruct
help text: The current phase of this Task, as defined by the type.

notes

protected java.lang.String notes

The full note thread summary in XHTML.

declared invalid value: "TASKHEAP_INVALID_REPORTTEXT"
Length in characters, normal: 2048 max: 1048576
declared metatype: XHTML
help text: The full note thread summary in XHTML.

componentType

protected int componentType

The type of component this was sourced from. Typical values are

declared default value: UNKNOWN

enumerated constant values:

• UNKNOWN("unknown") = 0
  
• TASK("Task") = 1
  
• PLAN("Plan") = 2
  
• EXTERNALPLAN("ExternalPlan") = 3
  

declared invalid value: -1
declared printname: component type
help text: The type of component this was sourced from.

sourceComponent

protected long sourceComponent

The PlanComponent this overview was generated from. The source field is last in the structure definition so it shows up in the bottom of the display, after the description and notes. Otherwise novice users accidentally click on it before reading the description and can get lost.

reference to class: org.sandev.TaskHeap.structs.PlanComponentStruct
declared printname: source component
help text: The PlanComponent this overview was generated from.

Constructor Detail

PlanComponentReportStruct

public PlanComponentReportStruct()