IWorkItem

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 IWorkItem
extends com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
```
The IWorkItem object allows to read attribute values of a work item from the COCKPIT project planning module.
Item type constant: "ppm.workItem"

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCategory()` Returns the category.
`java.util.List<java.lang.String>`	`getDescription()` Returns the description of the work item.
`java.lang.String`	`getDueDate()` Returns the due date of the work item, i.e. the due date of the parent task).
`com.arcway.cockpit.docgen.provider.interfaces.IModelElement`	`getLinkedUniqueElement()` Returns the linked unique element or null if non exists.
`java.lang.String`	`getName()` Returns the name of the work item.
`java.lang.String`	`getPercentWorkComplete()` Returns the percent work complete of this work item.
`java.lang.String`	`getPersonInCharge()` Returns the name of the person in charge.
`java.lang.String`	`getResources()` Returns the resources needed for this work item.
`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 worl item.
`java.lang.String`	`getWorkForecast()` Returns the work forecast of this work item.
`java.lang.String`	`getWorkRemaining()` Returns the work remaining of this wprl item.
`boolean`	`isComplete()` Checks whether the work items is complete.
`boolean`	`isInProgress()` Checks whether the work items is in progress.
`boolean`	`isLinkedWithUniqueElement()` Returns whether the work item is linked with a unique element.
`boolean`	`isNotStarted()` Checks whether the work items is not yet started.
`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 work item.
    
    The name is already HTML encoded so that it can be inserted into the document without any further tranformations.
    
    Returns:
    
    name of the work item (!= null)
  - getDescription
```
java.util.List<java.lang.String> getDescription()
```
    Returns the description of the work item. If the description consists of multiple lines (separated by carriage return) each line is represented by a single 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.
    
    Returns:
    
    Description text of the project, splitted into multiple strings, one for each line. (!= null)
  - getCategory
```
java.lang.String getCategory()
```
    Returns the category.
    
    Returns:
    
    category (never null) (may be null)
  - 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 worl item. The work has been estimated for this work item 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 wprl item. The work remaining is estimated 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 work item. 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 work item.
    
    Returns:
    
    percent work complete (including "%" letter)
  - isComplete
```
boolean isComplete()
```
    Checks whether the work items is complete.
    Complete means, that work has been done and no work is remaining.
    
    Returns:
    
    work item is complete
  - isInProgress
```
boolean isInProgress()
```
    Checks whether the work items is in progress.
    In Progress means, that work has been done and still work is remaining.
    
    Returns:
    
    work item is complete
  - isNotStarted
```
boolean isNotStarted()
```
    Checks whether the work items is not yet started.
    NotStarted means, that no work has been done.
    
    Returns:
    
    work item is complete
  - getDueDate
```
java.lang.String getDueDate()
```
    Returns the due date of the work item, i.e. the due date of the parent task).
    
    Returns:
    
    due date of the work item
  - getPersonInCharge
```
java.lang.String getPersonInCharge()
```
    Returns the name of the person in charge.
    
    Returns:
    
    the person in charge (never null) (may be null)
  - isLinkedWithUniqueElement
```
boolean isLinkedWithUniqueElement()
```
    Returns whether the work item is linked with a unique element.
    
    Returns:
    
    whether the work item is linked to a unique element
  - getLinkedUniqueElement
```
com.arcway.cockpit.docgen.provider.interfaces.IModelElement getLinkedUniqueElement()
```
    Returns the linked unique element or null if non exists.
    
    Returns:
    
    the linked unique element
  - getResources
```
java.lang.String getResources()
```
    Returns the resources needed for this work item.
    
    Returns:
    
    resources needed for this work (never null)
  - 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

Interface IWorkItem

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

getDescription

getCategory

getWorkDone

getWorkEstimated

getWorkRemaining

getWorkForecast

getPercentWorkComplete

isComplete

isInProgress

isNotStarted

getDueDate

getPersonInCharge

isLinkedWithUniqueElement

getLinkedUniqueElement

getResources

toRecord