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 history

Field Summary

protected java.lang.String	password The password to access the other heap.
protected int	refresh Whether this ExternalPlan should be refreshed from external data automatically or manually.
protected long	sourceID The ID 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

description, dueDate, name, notes, parent, resourceID, timeEstimate

Constructor Summary

ExternalPlanStruct()

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

sourceID

protected long sourceID

The ID of the plan in the other heap.

declared invalid value: -1

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

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

refresh

protected int refresh

Whether this ExternalPlan should be refreshed from external data automatically or manually. Automatic refresh is the default, and if the last modification time of the ExternalPlan exceeds the allowed latency as set in the HeapAttributes, then the ExternalPlan will be updated automatically the next time the main outline is viewed. If this is set to manual, then the time estimate will only be updated when fetched manually.

declared default value: AUTOMATIC

enumerated constant values:

• _AUTOMATIC = 0
  
• _MANUAL = 1
  

"is" boolean methods are generated for this field.
declared invalid value: -1

Constructor Detail

ExternalPlanStruct

public ExternalPlanStruct()