org.sandev.TaskHeap.structs
Class TaskTypeStruct

java.lang.Object
  org.sandev.TaskHeap.structs.TaskTypeStruct

Direct Known Subclasses:

TaskType

public class TaskTypeStruct
extends java.lang.Object

Describes a task type classification. Tasks can be divided into types based on the organizational needs of the heap. By default, TaskHeap includes the "development" and "bug" task types. For additional classifications, create additional TaskType instances.

It is recommended that the number of TaskType instances in a heap be kept to a minimum (preferably fewer than 7 types), for the heap to remain useful to users. Classification tends to degrade in quality with each additional defined type. Defining types to support search is NOT recommended since it leads to a proliferation of types and degradation of the heap. To support search markers, use keyword abbreviations in the task or plan name instead.

This message is persistent.
This message is a tree of values.
summary fields: name
This message has the following verb forms: update query collection
declared printname: Task Type
help text: A type of task. By default, TaskHeap includes types for "to-do", "development" and "bug". Other Task Types can be created as needed. It is recommended that the total number of Task Types for a heap be kept to 7 or fewer to facilitate classification when creating tasks.

Field Summary

protected java.lang.String	description A description of this type of task.
protected long	heap The heap this type belongs to.
protected java.lang.String	name An intuitive name for this task type.
protected long[]	phases A TaskType has allowable phases associated with it.

Constructor Summary

TaskTypeStruct()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

heap

protected long heap

The heap this type belongs to. Global TaskTypess have no associated heap and may be read by anyone but not modified. Heap-specific TaskTypes have the standard heap access semantics.

reference to class: org.sandev.TaskHeap.structs.HeapAttributesStruct
help text: The heap this task type definition belongs to.

name

protected java.lang.String name

An intuitive name for this task type. The name should be suitable for display in a drop-down box or other multiple choice UI paradigm.

the values for this field are unique.
declared invalid value: "TASKHEAP_INVALID_TASKTYPE_NAME"
Length in characters, normal: 15 max: 40
help text: An intuitive name for this task type. The name should be suitable for display in a drop-down box or other multiple choice UI paradigm. Typical examples might include development, bug, to-do, etc.

description

protected java.lang.String description

A description of this type of task. The description typically includes general guidelines, links to additional documents, expectations, responsibilities, and other information necessary for a resource working on a task.

declared default value: ""
declared invalid value: "TASKHEAP_INVALID_TASKTYPE_DESCRIPTION"
Length in characters, normal: 512 max: 1048576
help text: A description of this type of task. The description typically includes general guidelines, links to additional documents, expectations, responsibilities, and other information necessary for a resource working on a task.

phases

protected long[] phases

A TaskType has allowable phases associated with it. The phases are specific to each type instance because what happens between "pending" and "complete" (or whatever the endpoint phases are) varies with the type of task.

reference to class: org.sandev.TaskHeap.structs.TaskPhaseStruct
help text: A TaskType has allowable phases associated with it. The phases are specific to each type instance because what happens between "pending" and "complete" (or whatever the endpoint phases are) varies with the type of task.

The ordering of entries in the phase array is the same order shown in the display, but does not imply any specific workflow or phase transition verification. Conventions for modifying the status of the task are left to the workgroup.

Constructor Detail

TaskTypeStruct

public TaskTypeStruct()