org.sandev.TaskHeap.structs
Class ExternalPlanStruct

java.lang.Object
  org.sandev.TaskHeap.structs.PlanComponentStruct
      org.sandev.TaskHeap.structs.ExternalPlanStruct

Direct Known Subclasses:

ExternalPlan

public class ExternalPlanStruct
extends PlanComponentStruct

An ExternalPlan is the local representation of a Plan from another heap. This is useful for tracking interactions between groups with related work. The ExternalPlan contains enough information to read the other heap report and update its time based on what it finds.

This message is persistent.
summary fields: name timeEstimate resourceID
This message has the following verb forms: update query collection
declared printname: External Plan
help text: An ExternalPlan is the local representation of a Plan from another heap. This is useful for tracking interactions between groups with related work.

Field Summary

protected java.lang.String	password The password to access the other heap.
protected int	refresh How often the time estimate should be fetched from the external heap.
protected long	sourceID The uniqueID of the plan in the other heap.
protected java.lang.String	updateURL The URL to retrieve the latest heap information.
protected java.lang.String	username The username to access the other heap.

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

ExternalPlanStruct()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

updateURL

protected java.lang.String updateURL

The URL to retrieve the latest heap information.

declared invalid value: "TASKHEAP_INVALID_UPDATEURL"
Length in characters, normal: 60 max: 255
declared printname: update URL
help text: The URL to retrieve the latest heap information.

sourceID

protected long sourceID

The uniqueID of the plan in the other heap.

declared invalid value: -1
help text: The ID of the plan in the other heap.

username

protected java.lang.String username

The username to access the other heap.

declared invalid value: "TASKHEAP_INVALID_USERNAME"
Length in characters, normal: 10 max: 80
help text: The username to access the other heap.

password

protected java.lang.String password

The password to access the other heap.

input to this field input is hidden in the UI.
declared invalid value: "TASKHEAP_INVALID_PASSWORD"
Length in characters, normal: 10 max: 255
help text: The password to access the other heap.

refresh

protected int refresh

How often the time estimate should be fetched from the external heap. By default, the frequency of external checking is driven by the latency set in the heap attributes. To check more or less frequently, set the refresh frequency here. External plans can be refreshed manually at any time.

declared default value: DEFAULT

enumerated constant values:

• NONE("None, refresh manually") = -1
  
• DEFAULT("Use default heap setting") = 0
  
• HOURLY("Every hour") = 1
  
• EVERYTWO("Every 2 hours") = 2
  
• EVERYFOUR("Every 4 hours") = 4
  
• TWICEDAILY("Twice daily") = 12
  
• ONCEDAILY("Daily") = 24
  
• EVERYOTHER("Every other day") = 48
  
• WEEKLY("Weekly") = 168
  

declared invalid value: -1
help text: How often the time estimate should be fetched from the external heap. By default, the frequency of external checking is driven by the latency set in the heap attributes. To check more or less frequently, set the refresh frequency here. External plans can be refreshed manually at any time.

Constructor Detail

ExternalPlanStruct

public ExternalPlanStruct()