org.sandev.TaskHeap.structs
Class HeapAttributesStruct
java.lang.Object
org.sandev.TaskHeap.structs.HeapAttributesStruct
- Direct Known Subclasses:
- HeapAttributes
public class HeapAttributesStruct
- extends java.lang.Object
The description and settings for a heap.
This message is persistent.
This message is a tree of values.
summary fields: name account.name="account" status
This message has the following verb forms: update query collection
default field layout declaration:
<fieldlayout>
<layrow><name/></layrow>
<layrow><description colspan="4"/></layrow>
<layrow><groupURL colspan="4"/></layrow>
<layrow><account/><status/></layrow>
<layrow><defaultTaskType/><defaultView/></layrow>
<layrow><hoursPerDay/><externalPlanLatency valsuffix=" hrs"/></layrow>
<layrow><defaultDueDate/><activityIndicator/></layrow>
<layrow><title/><lineSummary/></layrow>
<layrow><dataUsername colspan="4"/></layrow>
<layrow><dataPassword colspan="4"/></layrow>
<layrow><decorationLevel/><adsSuspendedUntil/></layrow>
<layrow><taskHeapReportHeader colspan="4"/></layrow>
<layrow><taskHeapReportSig colspan="4"/></layrow>
</fieldlayout>
declared printname: Heap
help text: The description and settings for a heap.
|
Field Summary |
protected long |
account
The account that owns this heap. |
protected int |
activityIndicator
How the task outline should show recent activity. |
protected java.util.Date |
adsSuspendedUntil
The date your subscription ends and your heap switches to
being ad supported. |
protected java.lang.String |
dataPassword
The password required for access to exported data. |
protected java.lang.String |
dataUsername
The username required for access to exported data. |
protected int |
decorationLevel
Whether the generated report should have the header and footer
info in it or not. |
protected java.util.Date |
defaultDueDate
The default due date for all relative deadline tasks. |
protected long |
defaultTaskType
When a new task is created, by default it is of this type. |
protected int |
defaultView
The default filtering view. |
protected java.lang.String |
description
A brief description of this heap and what it is used for. |
protected int |
externalPlanLatency
The number of hours allowed to go by before the time estimate
for an ExternalPlan will be automatically refreshed from its
source. |
protected java.lang.String |
groupURL
The URL for the discussion group associated with this heap. |
protected PlanTreeElementStruct |
heap
The calculated heap display. |
protected int |
hoursPerDay
The number of applied work hours in a standard work day. |
protected int |
lineSummary
What info gets included with each line in the overview summary. |
protected java.lang.String |
name
A unique name identifying this heap. |
protected int |
status
The status of this heap. |
protected java.lang.String |
taskHeapReportHeader
Intro text for the TaskHeap report. |
protected java.lang.String |
taskHeapReportSig
Signature area text for the TaskHeap report. |
protected java.lang.String |
title
The title for this TaskHeap. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
name
protected java.lang.String name
- A unique name identifying this heap. The name be unique, and contain
only letters, numbers and spaces.
declared default value: ""
declared invalid value: ""
Length in characters, normal: 20 max: 60
help text: A unique name identifying this heap. The name must be unique, and may
contain only letters, numbers and spaces. Shorter names are preferable.
description
protected java.lang.String description
- A brief description of this heap and what it is used for.
declared invalid value: "TASKHEAP_INVALID_DESCRIPTION"
Length in characters, normal: 255 max: 4096
help text: A brief description of this heap and what it is used for.
account
protected long account
- The account that owns this heap.
reference to class: org.sandev.TaskHeap.structs.AccountStruct
help text: The account that owns this heap.
groupURL
protected java.lang.String groupURL
- The URL for the discussion group associated with this heap.
declared default value: ""
declared invalid value: "INVALID_GROUPURL"
Length in characters, normal: 70 max: 128
help text: We recommend setting up a discussion group to hold conversations
and supporting documents related to heap work. Google™,
Yahoo!™ and others offer these services at no cost. Record
the web address of your group here for easy access from your work
plan.
status
protected int status
- The status of this heap. Normally a heap is active. A suspended
heap may be read but not modified. An inactive heap is still
visible as existing, but is not accessible.
declared default value: ACTIVE
enumerated constant values:
ACTIVE("Active") = 0
SUSPENDED("Suspended") = 1
INACTIVE("Inactive") = 2
declared invalid value: -1
help text: The status of this heap. Normally a heap is active. A suspended
heap may be read but not modified. An inactive heap is still
visible as existing, but is not accessible.
adsSuspendedUntil
protected java.util.Date adsSuspendedUntil
- The date your subscription ends and your heap switches to
being ad supported.
declared default value: "Jan 1, 2002 11:00 PM"
Display format: "MMM d, yyyy h:mm a" editing format: "MMM d, yyyy h:mm a"
declared printname: ads suspended until
help text: The date your subscription ends and your heap switches to
being ad supported.
defaultTaskType
protected long defaultTaskType
- When a new task is created, by default it is of this type. If
you find that most tasks you create are of a different type (or
your own defined type), then change the default here to make entry
of new tasks faster.
declared default value: 1008
a dynamic selection display may be generated for this field.
reference to class: org.sandev.TaskHeap.structs.TaskTypeStruct
declared printname: default task type
help text: When a new task is created, by default it is of this type. If
you find that most tasks you create are of a different type (or
your own defined type), then change the default here to make entry
of new tasks faster.
defaultView
protected int defaultView
- The default filtering view. The view can be changed via the filter
button on the main page, this just sets what the initial value is
when you login to the heap.
declared default value: 0
enumerated constant values:
PROJALL("projected + rem/ttl") = 0
PROJREM("projected + remaining") = 1
PROJTTL("projected + total") = 2
PROJECTED("projected") = 3
DEADALL("deadline + rem/ttl") = 4
DEADREM("deadline + remaining") = 5
DEADTTL("deadline + total") = 6
DEADLINE("deadline") = 7
declared invalid value: -1
declared printname: default view
help text: The default filtering view. The view can be changed via the filter
button on the main page, this just sets what the initial value is
when you login to the heap.
defaultDueDate
protected java.util.Date defaultDueDate
- The default due date for all relative deadline tasks. Defaults to
5/10/2040 by which point we should be beyond the singularity so
changing it something smarter will be a snap :-)
declared default value: 2220235200000L
Display format: "MMM d, yyyy h:mm a" editing format: "MMM d, yyyy h:mm a"
declared printname: default due date
help text: The default due date for all relative deadline tasks.
hoursPerDay
protected int hoursPerDay
- The number of applied work hours in a standard work day. This
is used for estimating completion dates against a calendar.
declared default value: 8
declared invalid value: -1
range match expression: > 0
declared printname: hours per work day
help text: The number of applied work hours in a standard work day. This
is used for estimating completion dates against a calendar.
externalPlanLatency
protected int externalPlanLatency
- The number of hours allowed to go by before the time estimate
for an ExternalPlan will be automatically refreshed from its
source.
declared default value: 6
range match expression: > 0
declared printname: external plan latency
help text: The number of hours allowed to go by before the time estimate
for an ExternalPlan will be automatically refreshed from its
source.
activityIndicator
protected int activityIndicator
- How the task outline should show recent activity. By default
elements go from red to orange to green to blue to grey based
on how recently they were modified.
declared default value: CHROMACODE
enumerated constant values:
NONE("none") = 0
CHROMACODE("chromacode") = 1
"is" boolean methods are generated for this field.
declared invalid value: -1
declared printname: activity indicator
help text: How the task outline should show recent activity. By default
elements go from red to orange to green to blue to grey based
on how recently they were modified.
lineSummary
protected int lineSummary
- What info gets included with each line in the overview summary.
Each line in the main indented outline (aka "Work Breakdown
Summary" or "WBS"), has fields associated with it that provide
overview information about the element. All the information is
usually useful, but can appear somewhat cluttered or may be in
flux as estimates solidify. This field allows the summary output
to be filtered based on the needs of those reading the report.
declared default value: ALL
enumerated constant values:
STATUS("status") = 0
HOURS("hours") = 1
TARGETDATE("date") = 2
ALL("all") = 3
"is" boolean methods are generated for this field.
declared invalid value: -1
declared printname: report line summary
help text: What info gets included with each line in the overview summary.
Each line in the main indented outline (aka "Work Breakdown
Summary" or "WBS"), has fields associated with it that provide
overview information about the element. All the information is
usually useful, but can appear somewhat cluttered or may be in
flux as estimates solidify. This field allows the summary output
to be filtered based on the needs of those reading the report.
title
protected java.lang.String title
- The title for this TaskHeap. Used for generated report output.
declared default value: "TaskHeap"
declared invalid value: "TASKHEAP_INVALID_TITLE"
Length in characters, normal: 30 max: 80
declared printname: report title
help text: The title for this TaskHeap. Used for generated report output.
decorationLevel
protected int decorationLevel
- Whether the generated report should have the header and footer
info in it or not. Allows toggling of the report output while
leaving the header and footer information around. For example
an internal report might not include confidentiality statements
in the header or copyright information in the sig.
declared default value: CONTENTONLY
enumerated constant values:
CONTENTONLY("content only") = 0
HEADERONLY("include header text") = 1
FOOTERONLY("include footer text") = 2
FULLDECO("include header and footer") = 3
declared invalid value: -1
declared printname: report decoration level
help text: Whether the generated report should have the header and footer
info in it or not. Allows toggling of the report output while
leaving the header and footer information around. For example
an internal report might not include confidentiality statements
in the header or copyright information in the sig.
dataUsername
protected java.lang.String dataUsername
- The username required for access to exported data. When you export
information from the TaskHeap Admin screen (by clicking the
"Export Data", or "TaskHeap Report" buttons), the data is written
out to a protected website where it can be referenced by anyone
who knows the username/password for your data area.
declared default value: ""
declared invalid value: ""
Length in characters, normal: 15 max: 80
declared printname: report access username
help text: The username required for access to exported data. When you export
information from the TaskHeap Admin screen (by clicking the
"Export Data", or "TaskHeap Report" buttons), the data is written
out to a protected website where it can be referenced by anyone
who knows the report access username/password.
dataPassword
protected java.lang.String dataPassword
- The password required for access to exported data.
declared default value: ""
input to this field input is hidden in the UI.
declared invalid value: "TASKHEAPCOM_INVALID_PASSWORD"
Length in characters, normal: 15 max: 80
declared printname: report access password
help text: The password required for access to exported data.
taskHeapReportHeader
protected java.lang.String taskHeapReportHeader
- Intro text for the TaskHeap report. This is displayed before
the main indented heap information in the report.
declared default value: "TaskHeap Project"
declared invalid value: "TASKHEAP_INVALID_REPORTHEADER"
Length in characters, normal: 255 max: 4096
declared metatype: XHTML
declared printname: report header text
help text: Intro text for the TaskHeap report. This is displayed before
the main indented heap information in the report.
taskHeapReportSig
protected java.lang.String taskHeapReportSig
- Signature area text for the TaskHeap report. This is displayed
immediately after the indented heap information in the report.
declared invalid value: "TASKHEAP_INVALID_REPORTHEADER"
Length in characters, normal: 255 max: 4096
declared metatype: XHTML
declared printname: report signature text
help text: Signature area text for the TaskHeap report. This is displayed
immediately after the indented heap information in the report.
heap
protected transient PlanTreeElementStruct heap
- The calculated heap display. Reserved for HeapCalculator processing.
which maintains this as the top level most expanded view possible.
HeapAttributesStruct
public HeapAttributesStruct()