ITask

All Superinterfaces:

com.arcway.cockpit.docgen.provider.interfaces.ICockpitData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess, com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData
```
public interface ITask
extends com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
```
The IProjectPlan object allows to read attribute values of a project plan from the COCKPIT project planning module. Starting with this object, you can get references to tasks and work items of the project plan.
Item type constant: "ppm.task"

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`containsWorkItems()` Checks whether the task contains any work items.
`java.lang.String`	`getDuration()` Returns the duration of this task in working days.
`java.lang.String`	`getFinish()` Returns the finish date of the task.
`java.lang.String`	`getName()` Returns the name of the task.
`ITask`	`getParentTask()` Returns the parent task of the current task.
`java.lang.String`	`getPercentWorkComplete()` Returns the percent work complete of this task.
`java.lang.String`	`getStart()` Returns the start date of the task.
`java.lang.String`	`getState()` Returns s string donating the state of the task.
`java.util.List<? extends ITask>`	`getSubTasks()` Returns the sub tasks of the current task.
`java.util.List<? extends ITask>`	`getSubTasks(int sortingCriterion)` Returns the sub tasks of the current task.
`java.util.List<? extends ITask>`	`getSubTasks(java.lang.String sortingProperty)` Returns the sub tasks of the current task.
`java.lang.String`	`getUniqueIdentifier()` Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
`java.lang.String`	`getWorkDone()` Returns the work done of this task.
`java.lang.String`	`getWorkEstimated()` Returns the work estimated of this task.
`java.lang.String`	`getWorkForecast()` Returns the work forecast of this task.
`java.util.List<? extends IWorkItem>`	`getWorkItems()` Returns the work items of this task.
`java.util.List<? extends IWorkItem>`	`getWorkItems(int sortingCriterion)` Returns the work items of this task.
`java.util.List<? extends IWorkItem>`	`getWorkItems(java.lang.String sortingProperty)` Returns the work items of this task.
`java.lang.String`	`getWorkRemaining()` Returns the work remaining of this task.
`boolean`	`hasParent()` Checks whether the task has a parent task.
`boolean`	`hasSubTasks()` Checks whether the task has sub tasks.
`com.arcway.cockpit.docgen.provider.interfaces.IRecord`	`toRecord()` Converts this generic module data into a record.

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
getCategoryID, getCategoryLabel, getDateTimeProperty_MilliSecondsSince_01_01_1970, getFileProperty, getFileProperty, getFilePropertyAsBase64StringList, getFilePropertyAsFileName, getFilePropertyAsFileName, getFilePropertyAsRawStringList, getFilePropertyAsStringList, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringList, hasCustomPropertyValues, hasDefaultCategory, hasPropertyValue, readImageInfoOfFileProperty

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
getCommitVersion, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

- Method Detail
  - getUniqueIdentifier
```
java.lang.String getUniqueIdentifier()
```
    Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
    
    Specified by:
    
    getUniqueIdentifier in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
    
    Returns:
    
    unique identifier
  - getName
```
java.lang.String getName()
```
    Returns the name of the task.
    
    The name is already HTML encoded so that it can be inserted into the document without any further tranformations.
    
    Returns:
    
    name of the task (!= null)
  - containsWorkItems
```
boolean containsWorkItems()
```
    Checks whether the task contains any work items.
    
    Returns:
    
    true: task contains work items
  - getWorkItems
```
java.util.List<? extends IWorkItem> getWorkItems()
```
    Returns the work items of this task. If the task does not contain any work items, an empty array will be returned.
    
    The work items are sorted by name.
    
    Returns:
    
    work items of tis task
  - getWorkItems
```
java.util.List<? extends IWorkItem> getWorkItems(int sortingCriterion)
```
    Returns the work items of this task. If the task does not contain any work items, an empty array will be returned. sortingCriterion specifies the criterion for sorting. Use the integer constants in IProjectPlanningDataProvider.
    
    Returns:
    
    work items of tis task
  - getWorkItems
```
java.util.List<? extends IWorkItem> getWorkItems(java.lang.String sortingProperty)
```
    Returns the work items of this task. If the task does not contain any work items, an empty array will be returned. sortingProperty specifies the custom property which shall be used as a criterion for sorting.
    
    Returns:
    
    work items of tis task
  - hasSubTasks
```
boolean hasSubTasks()
```
    Checks whether the task has sub tasks.
    
    Returns:
    
    true: the task has sub tasks
  - getSubTasks
```
java.util.List<? extends ITask> getSubTasks()
```
    Returns the sub tasks of the current task. If the task has no sub tasks, an empty array is returned.
    
    The tasks are sorted by start date.
    
    Returns:
    
    array of sub tasks.
  - getSubTasks
```
java.util.List<? extends ITask> getSubTasks(int sortingCriterion)
```
    Returns the sub tasks of the current task. If the task has no sub tasks, an empty array is returned. sortingCriterion specifies the criterion for sorting. Use the integer constants in IProjectPlanningDataProvider.
    
    Returns:
    
    array of sub tasks.
  - getSubTasks
```
java.util.List<? extends ITask> getSubTasks(java.lang.String sortingProperty)
```
    Returns the sub tasks of the current task. If the task has no sub tasks, an empty array is returned. sortingProperty specifies the custom property which shall be used as a criterion for sorting.
    
    Returns:
    
    array of sub tasks.
  - hasParent
```
boolean hasParent()
```
    Checks whether the task has a parent task. Root tasks have no parent task.
    
    Returns:
    
    true: task has a pernt task
  - getParentTask
```
ITask getParentTask()
```
    Returns the parent task of the current task. Root tasks have no parent task.
    
    Returns:
    
    parent task of the current task or null if the task has no parent task.
  - getWorkDone
```
java.lang.String getWorkDone()
```
    Returns the work done of this task. The unit of work (days/hours) is included in the returned string. Which unit is used depends on the current user preferences.
    
    Returns:
    
    work done (including unit)
  - getWorkEstimated
```
java.lang.String getWorkEstimated()
```
    Returns the work estimated of this task. The work has been estimated for each work item of this task before the work has started. The unit of work (days/hours) is included in the returned string. Which unit is used depends on the current user preferences.
    
    Returns:
    
    work estimated (including unit)
  - getWorkRemaining
```
java.lang.String getWorkRemaining()
```
    Returns the work remaining of this task. The work remaining is estimated for each work item after the work has started. The unit of work (days/hours) is included in the returned string. Which unit is used depends on the current user preferences.
    
    Returns:
    
    work remaining (including unit)
  - getWorkForecast
```
java.lang.String getWorkForecast()
```
    Returns the work forecast of this task. The work forecast is calculated on base of the work done and the estimated work remaining. The unit of work (days/hours) is included in the returned string. Which unit is used depends on the current user preferences.
    
    Returns:
    
    work forecast (including unit)
  - getPercentWorkComplete
```
java.lang.String getPercentWorkComplete()
```
    Returns the percent work complete of this task.
    
    Returns:
    
    percent work complete (including "%" letter)
  - getStart
```
java.lang.String getStart()
```
    Returns the start date of the task.
    
    The date string is already HTML encoded so that it can be inserted into the document without any further tranformations.
    
    Returns:
    
    start date of the task
  - getFinish
```
java.lang.String getFinish()
```
    Returns the finish date of the task.
    
    The date string is already HTML encoded so that it can be inserted into the document without any further tranformations.
    
    Returns:
    
    finish date of the task
  - getDuration
```
java.lang.String getDuration()
```
    Returns the duration of this task in working days.
    
    Returns:
    
    duration in working days (including unit days)
  - getState
```
java.lang.String getState()
```
    Returns s string donating the state of the task. Possible states are:
    - future task
    - on schedule
    - late
    - comlete
    Returns:
    
    state of the task
  - toRecord
```
com.arcway.cockpit.docgen.provider.interfaces.IRecord toRecord()
```
    Converts this generic module data into a record.
    In addition to all fields documented at ICustomPropertiesAccess.toRecord(), in the created record, the following fields are filled accoring to the wrapped cockpit data:
    - IRecord.NAME_KEY
    Specified by:
    
    toRecord in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
    
    Specified by:
    
    toRecord in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
    
    Returns:
    
    converted cockpit project data

Interface ITask

Method Summary

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

Method Detail

getUniqueIdentifier

getName

containsWorkItems

getWorkItems

getWorkItems

getWorkItems

hasSubTasks

getSubTasks

getSubTasks

getSubTasks

hasParent

getParentTask

getWorkDone

getWorkEstimated

getWorkRemaining

getWorkForecast

getPercentWorkComplete

getStart

getFinish

getDuration

getState

toRecord