org.sandev.TaskHeap.structs
Class PlanStruct

java.lang.Object
  extended by org.sandev.TaskHeap.structs.PlanComponentStruct
      extended by org.sandev.TaskHeap.structs.PlanStruct
Direct Known Subclasses:
Plan

public class PlanStruct
extends PlanComponentStruct

A Plan represents a collection of a logical chunk of work. The work may be consist of tasks, other plans, external plans, or some combination of these.

Plans are used to represent milestones, logical task groupings, or other organizational requirements. They can be created to organize existing work (bottom up planning), or as placeholders for work yet to be defined (top down planning). The time estimate for a plan is either the sum of all contained components (sequential rollup), or the maximum time value of all contained components (parallel rollup).

This message can be transmitted directly outside of a verb form.
This message is persistent.
This message is a tree of values.
summary fields: name timeEstimate resourceID
This message has the following verb forms: update query collection
declared printname: Plan
help text:

A Plan represents a collection of a logical chunk of work. The work may be consist of tasks, other plans, external plans, or some combination of these.

Plans are used to represent milestones, logical task groupings, or other organizational requirements. They can be created to organize existing work (bottom up planning), or as placeholders for work yet to be defined (top down planning). The time estimate for a plan is either the sum of all contained components (sequential rollup), or the maximum time value of all contained components (parallel rollup).



Field Summary
protected  long[] components
          The components that make up this plan.
protected  int execution
          Plan components can either represent a sequence of actions, or a group of actions occurring at the same time.
protected  int visibility
          A Plan can be marked as hidden to reduce clutter in the output.
 
Fields inherited from class org.sandev.TaskHeap.structs.PlanComponentStruct
assignedTo, description, dueDate, dueDelta, dueDeltaSense, dueDeltaValue, dueReference, dueTimeUnits, dueType, heap, name, notes, parent, relRoundDay, relRounding, responsibilities, timeEstimate
 
Constructor Summary
PlanStruct()
           
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

components

protected long[] components
The components that make up this plan.

reference to class: org.sandev.TaskHeap.structs.PlanComponentStruct
help text: The components that make up this plan.

execution

protected int execution
Plan components can either represent a sequence of actions, or a group of actions occurring at the same time. The components of a sequential plan are added together to form the elapsed time. For a parallel plan, the maximum time for any component determines the elapsed time.

declared default value: SEQUENTIAL

enumerated constant values:

  • SEQUENTIAL("sequential - summation rollup") = 0
  • PARALLEL("parallel - max time rollup") = 1
declared invalid value: -1
help text: Plan components can either represent a sequence of actions, or a group of actions occurring at the same time. The components of a sequential plan are added together to form the elapsed time. For a parallel plan, the maximum time for any component determines the elapsed time.

visibility

protected int visibility
A Plan can be marked as hidden to reduce clutter in the output. This is useful for reducing the size of the main heap outline by removing completed work from view.

declared default value: INTERNAL

enumerated constant values:

  • INTERNAL("internal") = 0
  • HIDDEN("hidden") = 2
declared invalid value: -1
help text: A Plan can be marked as hidden to reduce clutter in the output. This is useful for reducing the size of the main heap outline by removing completed work from view.
Constructor Detail

PlanStruct

public PlanStruct()