com.arcway.cockpit.projectplanningmodule2.docgen.provider.interfaces

Interface IProjectPlan

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 IProjectPlan
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.projectPlan"

Method Summary

Modifier and Type	Method and Description
boolean	containsTasks() Checks whether the project plan contains any tasks.
java.util.List<java.lang.String>	getDescription() Returns the description of the project.
java.lang.String	getName() Returns the name of the project plan.
java.util.List	getResourceNames() Returns the names of resources required for this project plan.
java.util.List<? extends ITask>	getRootTasks() Returns the root (level 1) tasks of the project plan.
java.util.List<? extends ITask>	getRootTasks(int sortingCriterion) Returns the root (level 1) tasks of the project plan.
java.util.List<? extends ITask>	getRootTasks(java.lang.String sortingProperty) Returns the root (level 1) tasks of the project plan.
java.lang.String	getUniqueIdentifier() Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
java.lang.String	getWorkDoneOfResource(java.lang.String resourceName) Returns the current work done of the specified resource.
java.lang.String	getWorkEstimated() Returns the estimated work for a project plan.
java.lang.String	getWorkOfResource(java.lang.String resourceName) Returns the current work forecast of the specified resource.
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.

Example from report template:

#foreach($projectPlan in ${projectPlanningDataProvider.ProjectPlans})
#set($project_uid = ${project.UniqueIdentifier})
#end

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 project plan.

The project plan name is already HTML encoded so that it can be inserted into the document without any further tranformations.

Example from report template:

#set($project = ${projectDataProvider.Project})
Projektname: ${project.Name}

Returns:

name of the project (!= null)

getDescription

java.util.List<java.lang.String> getDescription()

Returns the description of the project. If the description consists of multiple lines (ENTER) each line is represented by an element in the String array.

The description text is already HTML encoded so that it can be inserted into the document without any further tranformations.

Example from report template:

#set($project = ${projectDataProvider.Project})
#foreach( $text in ${project.Description})
<para>$text</para>
#end

Returns:

Description text of the project, splitted into multiple strings, one for each line. (!= null)

containsTasks

boolean containsTasks()

Checks whether the project plan contains any tasks.

Returns:

true: the project plan contains tasks.

getRootTasks

java.util.List<? extends ITask> getRootTasks()

Returns the root (level 1) tasks of the project plan.

The tasks are sorted by start date.

Returns:

Array of tasks on level 1 (not null)

getRootTasks

java.util.List<? extends ITask> getRootTasks(int sortingCriterion)

Returns the root (level 1) tasks of the project plan.

sortingCriterion specifies the criterion for sorting. Use the integer constants in IProjectPlanningDataProvider.

Parameters:

sortingCriterion - one of the constants defined in IProjectPlanningDataProvider

Returns:

Array of tasks on level 1 (not null)

getRootTasks

java.util.List<? extends ITask> getRootTasks(java.lang.String sortingProperty)

Returns the root (level 1) tasks of the project plan. sortingProperty specifies the custom property which shall be used as a criterion for sorting.

Parameters:

sortingProperty - the ID of the custom property

Returns:

Array of tasks on level 1 (not null)

getResourceNames

java.util.List getResourceNames()

Returns the names of resources required for this project plan.

Returns:

List of resource names (sorted alphabetically).

getWorkOfResource

java.lang.String getWorkOfResource(java.lang.String resourceName)

Returns the current work forecast of the specified resource. The unit of work (days/hours) is included in the returned string. Which unit is used depends on the current user preferences.

Parameters:

resourceName - name of the resource

Returns:

work forecast (including unit)

getWorkDoneOfResource

java.lang.String getWorkDoneOfResource(java.lang.String resourceName)

Returns the current work done of the specified resource. The unit of work (days/hours) is included in the returned string. Which unit is used depends on the current user preferences.

Parameters:

resourceName - name of the resource

Returns:

work done (including unit)

getWorkEstimated

java.lang.String getWorkEstimated()

Returns the estimated work for a project plan. 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)

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
• IRecord.DESCRIPTION_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