IProjectPlanningDataProvider

```
public interface IProjectPlanningDataProvider
```
The IProjectPlanningDataProvider allows to access objects of a COCKPIT project for document generation. The IProjectPlanningDataProvider can be referenced directly within a document template by its name projectPlanningDataProvider.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.util.List<? extends IProjectPlan>`	`getAllProjectPlansForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry)` Returns all project plans which have been modified the last time with the commit identified by the history item.
`java.util.List<? extends ITask>`	`getAllTasksForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry)` Returns all tasks which have been modified the last time with the commit identified by the history item.
`java.util.List<? extends IWorkItem>`	`getAllWorkItemsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry)` Returns all work items which have been modified the last time with the commit identified by the history item.
`java.util.List<IProjectPlan>`	`getProjectPlans()` Returns all project plans of this COCKPIT project.
`java.util.List<IProjectPlan>`	`getProjectPlans(java.lang.String sortingProperty)` Returns all project plans of this COCKPIT project.
`int`	`getSORT_TASK_BY_DURATION()` Constant for sorting tasks by duration (descending)
`int`	`getSORT_TASK_BY_ENDDATE()` Constant for sorting tasks by end date
`int`	`getSORT_TASK_BY_NAME()` Constant for sorting tasks by name
`int`	`getSORT_TASK_BY_PERCENTWORKCOMPLETE()` Constant for sorting tasks by percent of work that is completed (descending)
`int`	`getSORT_TASK_BY_STARTDATE()` Constant for sorting tasks by start date
`int`	`getSORT_TASK_BY_STATE()` Constant for sorting tasks by state
`int`	`getSORT_TASK_BY_TOTALWORK()` Constant for sorting tasks by total work (descending)
`int`	`getSORT_WORKITEM_BY_NAME()` Constant for sorting work items by name
`int`	`getSORT_WORKITEM_BY_PERCENTWORKCOMPLETE()` Constant for sorting work items by percent of work that is completed (descending)
`int`	`getSORT_WORKITEM_BY_TOTALWORK()` Constant for sorting work items by total work (descending)
`java.util.List<? extends IWorkItem>`	`getUnassignedWorkItems()` Returns all work items which are no assigned to tasks.
`java.util.List<? extends IWorkItem>`	`getUnassignedWorkItems(int sortingCriterion)` Returns all work items which are no assigned to tasks.
`java.util.List<? extends IWorkItem>`	`getUnassignedWorkItems(java.lang.String sortingProperty)` Returns all work items which are no assigned to tasks.
`java.util.List<? extends IWorkItem>`	`getWorkItemsForStakeholder(java.lang.String stakeholdername)` Returns all work items which are linked to the specified stakeholder.
`java.util.List<? extends IWorkItem>`	`getWorkItemsForStakeholder(java.lang.String stakeholdername, int sortingCriterion)` Returns all work items which are linked to the specified stakeholder.
`java.util.List<? extends IWorkItem>`	`getWorkItemsForStakeholder(java.lang.String stakeholdername, java.lang.String sortingProperty)` Returns all work items which are linked to the specified stakeholder.
`java.util.List<? extends IWorkItem>`	`getWorkItemsForUniqueElement(java.lang.String uniqueElementUID)` Returns all work items which are linked to the specified unique element (repository element).
`java.util.List<? extends IWorkItem>`	`getWorkItemsForUniqueElement(java.lang.String uniqueElementUID, int sortingCriterion)` Returns all work items which are linked to the specified unique element (repository element).
`java.util.List<? extends IWorkItem>`	`getWorkItemsForUniqueElement(java.lang.String uniqueElementUID, java.lang.String sortingProperty)` Returns all work items which are linked to the specified unique element (repository element).
`boolean`	`hasWorkItemsForUniqueElement(java.lang.String uniqueElementUID)` Checks whether the specified unique element (repository element) is linked with work items.

- Method Detail
  - getSORT_TASK_BY_STARTDATE
```
int getSORT_TASK_BY_STARTDATE()
```
    Constant for sorting tasks by start date
  - getSORT_TASK_BY_ENDDATE
```
int getSORT_TASK_BY_ENDDATE()
```
    Constant for sorting tasks by end date
  - getSORT_TASK_BY_DURATION
```
int getSORT_TASK_BY_DURATION()
```
    Constant for sorting tasks by duration (descending)
  - getSORT_TASK_BY_STATE
```
int getSORT_TASK_BY_STATE()
```
    Constant for sorting tasks by state
  - getSORT_TASK_BY_PERCENTWORKCOMPLETE
```
int getSORT_TASK_BY_PERCENTWORKCOMPLETE()
```
    Constant for sorting tasks by percent of work that is completed (descending)
  - getSORT_TASK_BY_TOTALWORK
```
int getSORT_TASK_BY_TOTALWORK()
```
    Constant for sorting tasks by total work (descending)
  - getSORT_TASK_BY_NAME
```
int getSORT_TASK_BY_NAME()
```
    Constant for sorting tasks by name
  - getSORT_WORKITEM_BY_NAME
```
int getSORT_WORKITEM_BY_NAME()
```
    Constant for sorting work items by name
  - getSORT_WORKITEM_BY_TOTALWORK
```
int getSORT_WORKITEM_BY_TOTALWORK()
```
    Constant for sorting work items by total work (descending)
  - getSORT_WORKITEM_BY_PERCENTWORKCOMPLETE
```
int getSORT_WORKITEM_BY_PERCENTWORKCOMPLETE()
```
    Constant for sorting work items by percent of work that is completed (descending)
  - getProjectPlans
```
java.util.List<IProjectPlan> getProjectPlans()
```
    Returns all project plans of this COCKPIT project.
    The project plans are sorted by name.
    The following example will list the names of all project plans:
    
    #set($projectPlans = ${projectPlanningDataProvider.ProjectPlans}) #foreach($projectPlan in $projectPlans) <para>${projectPlan.Name}</para> #end
    Returns: root object of a COCKPIT project
  getProjectPlans java.util.List<IProjectPlan> getProjectPlans(java.lang.String sortingProperty) Returns all project plans of this COCKPIT project. sortingProperty specifies the custom property which shall be used as a criterion for sorting. Returns: root object of a COCKPIT project getUnassignedWorkItems java.util.List<? extends IWorkItem> getUnassignedWorkItems() Returns all work items which are no assigned to tasks. The work items are sorted by name. Returns: al work items which are not assigned to a task getUnassignedWorkItems java.util.List<? extends IWorkItem> getUnassignedWorkItems(int sortingCriterion) Returns all work items which are no assigned to tasks. sortingCriterion specifies the criterion for sorting. Use the integer constants in IProjectPlanningDataProvider. Returns: al work items which are not assigned to a task getUnassignedWorkItems java.util.List<? extends IWorkItem> getUnassignedWorkItems(java.lang.String sortingProperty) Returns all work items which are no assigned to tasks. sortingProperty specifies the custom property which shall be used as a criterion for sorting. Returns: al work items which are not assigned to a task hasWorkItemsForUniqueElement boolean hasWorkItemsForUniqueElement(java.lang.String uniqueElementUID) Checks whether the specified unique element (repository element) is linked with work items. Parameters: uniqueElementUID - UID of the unique element (repository) the work items must be linked with Returns: true: some work items are linked with the unique element getWorkItemsForUniqueElement java.util.List<? extends IWorkItem> getWorkItemsForUniqueElement(java.lang.String uniqueElementUID) Returns all work items which are linked to the specified unique element (repository element). The work items are sorted by name. Parameters: uniqueElementUID - UID of the unique element (repository) the work items must be linked with Returns: work items linked with the specified unique element getWorkItemsForUniqueElement java.util.List<? extends IWorkItem> getWorkItemsForUniqueElement(java.lang.String uniqueElementUID, int sortingCriterion) Returns all work items which are linked to the specified unique element (repository element). sortingCriterion specifies the criterion for sorting. Use the integer constants in IProjectPlanningDataProvider. Parameters: uniqueElementUID - UID of the unique element (repository) the work items must be linked with sortingCriterion - specifies the criterion for sorting. Use the integer constants in IProjectPlanningDataProvider. Returns: work items linked with the specified unique element getWorkItemsForUniqueElement java.util.List<? extends IWorkItem> getWorkItemsForUniqueElement(java.lang.String uniqueElementUID, java.lang.String sortingProperty) Returns all work items which are linked to the specified unique element (repository element). Parameters: uniqueElementUID - UID of the unique element (repository) the work items must be linked with sortingProperty - specifies the custom property which shall be used as a criterion for sorting. Returns: work items linked with the specified unique element getWorkItemsForStakeholder java.util.List<? extends IWorkItem> getWorkItemsForStakeholder(java.lang.String stakeholdername) Returns all work items which are linked to the specified stakeholder. The work items are sorted by name. Parameters: stakeholdername - name of the stakeholder the work items must be linked with Returns: work items linked with the specified stakeholder getWorkItemsForStakeholder java.util.List<? extends IWorkItem> getWorkItemsForStakeholder(java.lang.String stakeholdername, int sortingCriterion) Returns all work items which are linked to the specified stakeholder. Parameters: stakeholdername - name of the stakeholder the work items must be linked with sortingCriterion - specifies the criterion for sorting. Use the integer constants in IProjectPlanningDataProvider. Returns: work items linked with the specified stakeholder getWorkItemsForStakeholder java.util.List<? extends IWorkItem> getWorkItemsForStakeholder(java.lang.String stakeholdername, java.lang.String sortingProperty) Returns all work items which are linked to the specified stakeholder. Parameters: stakeholdername - name of the stakeholder the work items must be linked with sortingProperty - specifies the custom property which shall be used as a criterion for sorting. Returns: work items linked with the specified unique element getAllProjectPlansForHistoryItem java.util.List<? extends IProjectPlan> getAllProjectPlansForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry) Returns all project plans which have been modified the last time with the commit identified by the history item. Each time, a user commits the project, a history entry is created. Note: The current version of a project plan is only assigned to the history item for the commit of the last change of the project plan. This method does not allow to access old versions. Preconditions:none Postconditions:none Parameters: historyEntry - history item identifying the last change of the plans Returns: all project plans modified the last time with the given history item getAllTasksForHistoryItem java.util.List<? extends ITask> getAllTasksForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry) Returns all tasks which have been modified the last time with the commit identified by the history item. Each time, a user commits the project, a history entry is created. Note: The current version of a task is only assigned to the history item for the commit of the last change of the task. This method does not allow to access old versions. Preconditions:none Postconditions:none Parameters: historyEntry - history item identifying the last change of the plans Returns: all tasks modified the last time with the given history item getAllWorkItemsForHistoryItem java.util.List<? extends IWorkItem> getAllWorkItemsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry) Returns all work items which have been modified the last time with the commit identified by the history item. Each time, a user commits the project, a history entry is created. Note: The current version of a work item is only assigned to the history item for the commit of the last change of the work item. This method does not allow to access old versions. Preconditions:none Postconditions:none Parameters: historyEntry - history item identifying the last change of the plans Returns: all work items modified the last time with the given history item

Interface IProjectPlanningDataProvider

Method Summary

Method Detail

getSORT_TASK_BY_STARTDATE

getSORT_TASK_BY_ENDDATE

getSORT_TASK_BY_DURATION

getSORT_TASK_BY_STATE

getSORT_TASK_BY_PERCENTWORKCOMPLETE

getSORT_TASK_BY_TOTALWORK

getSORT_TASK_BY_NAME

getSORT_WORKITEM_BY_NAME

getSORT_WORKITEM_BY_TOTALWORK

getSORT_WORKITEM_BY_PERCENTWORKCOMPLETE

getProjectPlans

getProjectPlans

getUnassignedWorkItems

getUnassignedWorkItems

getUnassignedWorkItems

hasWorkItemsForUniqueElement

getWorkItemsForUniqueElement

getWorkItemsForUniqueElement

getWorkItemsForUniqueElement

getWorkItemsForStakeholder

getWorkItemsForStakeholder

getWorkItemsForStakeholder

getAllProjectPlansForHistoryItem

getAllTasksForHistoryItem

getAllWorkItemsForHistoryItem