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
Holds global settings for general operations, such as report output.
This message is persistent.
summary fields: title
This message has the following verb forms: update query collection
|
Field Summary |
protected int |
activityIndicator
Whether the report should be chromacoded for activity. |
protected int |
decorationLevel
Whether the generated report should have the header and footer
info in it or not. |
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 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 |
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 |
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
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 another type (such
as your own type), then change the default here to make entry of
new tasks easier.
declared default value: 1008
a dynamic selection display may be generated for this field.
reference to class: org.sandev.TaskHeap.structs.TaskTypeStruct
declared printname for field: default task type
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 = 0
_PROJREM = 1
_PROJTTL = 2
_PROJECTED = 3
_DEADALL = 4
_DEADREM = 5
_DEADTTL = 6
_DEADLINE = 7
declared invalid value: -1
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 for field: hours per work day
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 for field: external plan latency
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 for field: report title
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 for field: report header text
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 for field: report signature text
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 = 0
_HEADERONLY = 1
_FOOTERONLY = 2
_FULLDECO = 3
declared invalid value: -1
declared printname for field: report decoration level
activityIndicator
protected int activityIndicator
- Whether the report should be chromacoded for activity. The task
outline shows recently modified elements in red, older elements
in grey, and other elements in intermediate colors depending on
when they were last modified. This is helpful for monitoring
activity, and is the same as the output for the main screen.
However if the report is to be printed on a black and white
printer, color coding may make things harder to read.
declared default value: CHROMACODE
enumerated constant values:
_NONE = 0
_CHROMACODE = 1
"is" boolean methods are generated for this field.
declared invalid value: -1
declared printname for field: report chromacoding
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 = 0
_HOURS = 1
_TARGETDATE = 2
_ALL = 3
"is" boolean methods are generated for this field.
declared invalid value: -1
declared printname for field: report line summary
HeapAttributesStruct
public HeapAttributesStruct()