IProject

All Superinterfaces:

ICockpitData, ICustomPropertiesAccess
```
public interface IProject
extends ICustomPropertiesAccess
```
The IProject object allows to read attribute values of a COCKPIT project for document generation. Starting with this object, references to other entities of the COCKPIT project can be requested.
Item type constant: "project"

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.util.Collection<? extends IModelElement>`	`filterModelElementsOfType(java.util.Collection<IModelElement> modelElements, java.lang.String typeID)` Returns all model elements of the given collection, which are of the specified type.
`IFolder`	`findFolder(java.lang.String folderPath)` Searches the folder with the specified path.
`java.util.List<? extends IFolder>`	`getAllFoldersForHistoryItem(IHistoryEntry historyEntry)` Returns all folders which have been modified the last time with the commit identified by the history item.
`java.util.List<? extends IModelElement>`	`getAllModelElements()` Returns all model elements of the selected project sorted by their type and element names
`java.util.List<? extends IModelElement>`	`getAllModelElements(java.lang.String typeID)` Returns all model elements of the selected project of the specified type sorted by their element names.
`java.util.List<? extends IModelElement>`	`getAllModelElementsForHistoryItem(IHistoryEntry historyEntry)` Returns all model elements which have been modified the last time with the commit identified by the history item.
`java.util.List<? extends IModelElement>`	`getAllModelElementsWithCategory(java.lang.String categoryID)` Returns all model elements of this project that belong to the specified category sorted by their type and element names.
`java.util.List<? extends IModelElement>`	`getAllModelElementsWithCategory(java.lang.String categoryID, java.lang.String typeID)` Returns all model elements of this project of the specified type that belong to the specified category sorted by their type and element names.
`java.util.List<? extends IModelElement>`	`getAllModelElementsWithDefaultCategory()` Returns all model elements of this project that belong to the default category sorted by their type and element names.
`java.util.List<? extends IModelElement>`	`getAllModelElementsWithDefaultCategory(java.lang.String typeID)` Returns all model elements of this project of the specified type that belong to the default category sorted by their type and element names.
`java.util.List<? extends IPlan>`	`getAllPlans()` Returns all construction plans of the selected project sorted by their plan names
`java.util.List<? extends IPlan>`	`getAllPlansForHistoryItem(IHistoryEntry historyEntry)` Returns all plans which have been modified the last time with the commit identified by the history item.
`java.util.List<? extends IPlan>`	`getAllPlansInDefinedOrder()` Returns all construction plans of the selected project in the order they occur in the project
`java.util.List<? extends IStakeholderRole>`	`getAllStakeholderRoles()` Returns all stakeholder roles of this project.
`java.util.List<? extends IStakeholderRole>`	`getAllStakeholderRolesForHistoryItem(IHistoryEntry historyEntry)` Returns all Stakeholder Roles which have been modified the last time with the commit identified by the history item.
`java.util.List<? extends IStakeholderRole>`	`getAllStakeholderRolesWithCategory(java.lang.String categoryID)` Returns all stakeholder roles of this project that belong to the specified category.
`java.util.List<? extends IStakeholderRole>`	`getAllStakeholderRolesWithDefaultCategory()` Returns all stakeholder roles of this project that belong to the default category.
`java.util.List<? extends IStakeholder>`	`getAllStakeholders()` Returns all stakeholders of this project.
`java.util.List<? extends IStakeholder>`	`getAllStakeholdersForHistoryItem(IHistoryEntry historyEntry)` Returns all Stakeholders which have been modified the last time with the commit identified by the history item.
`java.util.List<? extends IStakeholder>`	`getAllStakeholdersWithCategory(java.lang.String categoryID)` Returns all stakeholders of this project that belong to the specified category.
`java.util.List<? extends IStakeholder>`	`getAllStakeholdersWithDefaultCategory()` Returns all stakeholders of this project that belong to the default category.
`java.util.List<java.lang.String>`	`getDescription()` Returns the description of the project.
`java.lang.String`	`getLabelForUID(java.lang.String uid)` Returns a label for the object with the specified unique identifier.
`java.lang.String`	`getLanguage()` Returns the language of the project.
`java.util.List<? extends IModelElement>`	`getLeafModelElementsOfCausalityRelationship()` Returns all model elements of the selected project, which are leaf elements of the causality relationship, i.e. which are not causally preceding any other model element.
`java.util.List<? extends IModelElement>`	`getLeafModelElementsOfContainmentRelationship()` Returns all model elements of the selected project, which are leaf elements of the containment relationship, i.e. which do not contain any other model element.
`java.lang.String`	`getLogo()` Returns a XML DocBook representation to access the project logo.
`java.lang.String`	`getName()` Returns the name of the COCKPIT project.
`java.util.List<? extends IHistoryEntry>`	`getProjectHistoryEntries()` Returns all entries of the project's history.
`java.util.List<? extends IFolder>`	`getRootFolders()` Returns the root folders of the project.
`java.util.List<? extends IFolder>`	`getRootFoldersWithCategory(java.lang.String categoryID)` Returns the root folders of the project that belong to the specified category.
`java.util.List<? extends IFolder>`	`getRootFoldersWithDefaultCategory()` Returns the root folders of the project that belong to the default category.
`java.util.List<? extends IModelElement>`	`getRootModelElementsOfCausalityRelationship()` Returns all model elements of the selected project, which are root elements of the causality relationship, i.e. for which no causally preceding model element exists.
`java.util.List<? extends IModelElement>`	`getRootModelElementsOfContainmentRelationship()` Returns all model elements of the selected project, which are root elements of the containment relationship, i.e. which are not contained in any other model element.
`java.util.List<? extends IPlan>`	`getRootPlans()` Returns the root plans of the project.
`IStakeholder`	`getStakeholderForCurrentUser()` Returns the stakeholder of the current user.
`IStakeholderRole`	`getStakeholderRole(java.lang.String roleName)` Returns the stakeholder role with the given name.
`java.lang.String`	`getUniqueIdentifier()` Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
`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, getLinkForShow, 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:
    
    #set($project = ${projectDataProvider.Project}) #set($project_uid = ${project.UniqueIdentifier})
    
    Specified by:
    
    getUniqueIdentifier in interface ICockpitData
    
    Returns:
    
    unique identifier
  - getName
```
java.lang.String getName()
```
    Returns the name of the COCKPIT project.
    
    The project name is already HTML encoded so that it can be inserted into the document without 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 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)
  - getLogo
```
java.lang.String getLogo()
```
    Returns a XML DocBook representation to access the project logo. The logo file is loaded from the server and stored in a temporary directory. The XML DocBook representation depends on the currently selected document writer which will transform the transitional format into the selected target format.
    Note: This function is available since ARCWAY Cockpit 3.1. In projects that are created with a version older than 3.1 this function may not work correctly. In this case, the logo file has not a valid extension (".jpg", ".gif", ".png") and will not be displayed for this reason. To fix this, open the project properties dialog with ACRWAY Cockpit 3.1 (or newer) and change the logo. After that operation, this function will work also with the older project.
    
    Returns:
    
    XML DocBook representation
  - getLanguage
```
java.lang.String getLanguage()
```
    Returns the language of the project. The language is provided as a lowercase ISO 639 code. If the language is unknown an empty string is returned.
    
    Returns:
    
    the language as lowercase ISO 639 code or an empty string
  - getRootFolders
```
java.util.List<? extends IFolder> getRootFolders()
```
    Returns the root folders of the project.
    
    Example from report template:
    
    #set($root_folders = ${projectDataProvider.getRootFolders()})
    
    Returns:
    
    root folders of the project (!=null)
  - getRootFoldersWithCategory
```
java.util.List<? extends IFolder> getRootFoldersWithCategory(java.lang.String categoryID)
```
    Returns the root folders of the project that belong to the specified category.
    
    Example from report template:
    
    #set($root_folders = ${projectDataProvider.getRootFoldersWithCategory("myCategory")})
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    root folders of the project that belong to the specified category (!=null)
  - getRootFoldersWithDefaultCategory
```
java.util.List<? extends IFolder> getRootFoldersWithDefaultCategory()
```
    Returns the root folders of the project that belong to the default category.
    
    Example from report template:
    
    #set($root_folders = ${projectDataProvider.getRootFoldersWithDefaultCategory()})
    
    Returns:
    
    root folders of the project that belong to the default category (!=null)
  - getRootPlans
```
java.util.List<? extends IPlan> getRootPlans()
```
    Returns the root plans of the project.
    
    Example from report template:
    
    #set($project = ${projectDataProvider.Project}) #set($root_plans = ${project.RootPlans})
    
    Returns:
    
    array of root plans of the project (!=null)
  - findFolder
```
IFolder findFolder(java.lang.String folderPath)
```
    Searches the folder with the specified path. A folder path is a "/" separated list of folder names (e.g. "folder1/folder1.2" means "folder1.2" as sub folder of "folder1").
    Example from report template:
    
    #set($project = ${projectDataProvider.Project}) #set($folder = ${project.findFolder("folder1/folder1.2")})
    
    Parameters:
    
    folderPath - list of folder names, separated by "/"
    
    Returns:
    
    folder, if found, else null
  - getAllPlans
```
java.util.List<? extends IPlan> getAllPlans()
```
    Returns all construction plans of the selected project sorted by their plan names
    
    Returns:
    
    array of plan objects sorted by their plan name (!=null)
  - getAllPlansInDefinedOrder
```
java.util.List<? extends IPlan> getAllPlansInDefinedOrder()
```
    Returns all construction plans of the selected project in the order they occur in the project
    
    Returns:
    
    array of plan objects as ordered in the project (!=null)
  - getAllStakeholders
```
java.util.List<? extends IStakeholder> getAllStakeholders()
```
    Returns all stakeholders of this project.
    
    Returns:
    
    stakeholders of the project sorted by their name
  - getAllStakeholdersWithCategory
```
java.util.List<? extends IStakeholder> getAllStakeholdersWithCategory(java.lang.String categoryID)
```
    Returns all stakeholders of this project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    stakeholders of the project that belong to the specified category sorted by their name
  - getAllStakeholdersWithDefaultCategory
```
java.util.List<? extends IStakeholder> getAllStakeholdersWithDefaultCategory()
```
    Returns all stakeholders of this project that belong to the default category.
    
    Returns:
    
    stakeholders of the project that belong to the default category sorted by their name
  - getStakeholderForCurrentUser
```
IStakeholder getStakeholderForCurrentUser()
```
    Returns the stakeholder of the current user. If no stakeholder is assigned for this user or when COCKPIT runs in Standalone Mode this methods returns null.
    
    Returns:
    
    stakeholders for current user
  - getAllStakeholderRoles
```
java.util.List<? extends IStakeholderRole> getAllStakeholderRoles()
```
    Returns all stakeholder roles of this project.
    
    Returns:
    
    stakeholder roles of the project sorted by their names
  - getAllStakeholderRolesWithCategory
```
java.util.List<? extends IStakeholderRole> getAllStakeholderRolesWithCategory(java.lang.String categoryID)
```
    Returns all stakeholder roles of this project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    stakeholder roles of the project that belong to the specified category sorted by their names
  - getAllStakeholderRolesWithDefaultCategory
```
java.util.List<? extends IStakeholderRole> getAllStakeholderRolesWithDefaultCategory()
```
    Returns all stakeholder roles of this project that belong to the default category.
    
    Returns:
    
    stakeholder roles of the project that belong to the default category sorted by their names
  - getStakeholderRole
```
IStakeholderRole getStakeholderRole(java.lang.String roleName)
```
    Returns the stakeholder role with the given name.
    
    Parameters:
    
    roleName - the name of the requested role
    
    Returns:
    
    StakeholderProxy object or null if no such stakeholder role exists
  - getAllModelElements
```
java.util.List<? extends IModelElement> getAllModelElements()
```
    Returns all model elements of the selected project sorted by their type and element names
    
    Returns:
    
    a list of all model elements of the selected project (!=null)
  - getAllModelElements
```
java.util.List<? extends IModelElement> getAllModelElements(java.lang.String typeID)
```
    Returns all model elements of the selected project of the specified type sorted by their element names.
    
    The supported model element types including their typeID can be retrieved from the IProjectDataProvider.
    Example from report template:
    
    #set($project = ${projectDataProvider.Project}) #set($elementTypes = ${projectDataProvider.ModelElementTypes}) #foreach($type in $elementTypes) #foreach($modelElement in ${project.AllModelElements($type.TypeID)}) ... #end #end
    
    Parameters:
    
    typeID - the type id
    
    Returns:
    
    a list of all model elements of the selected project of the specified type (!=null)
  - getAllModelElementsWithCategory
```
java.util.List<? extends IModelElement> getAllModelElementsWithCategory(java.lang.String categoryID)
```
    Returns all model elements of this project that belong to the specified category sorted by their type and element names.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    a list of all model elements of this project that belong to the specified category (!=null)
  - getAllModelElementsWithCategory
```
java.util.List<? extends IModelElement> getAllModelElementsWithCategory(java.lang.String categoryID,
                                                                        java.lang.String typeID)
```
    Returns all model elements of this project of the specified type that belong to the specified category sorted by their type and element names.
    
    Parameters:
    
    categoryID - the category ID
    
    typeID - the type ID
    
    Returns:
    
    a list of all model elements of this project that belong to the specified category (!=null)
  - getAllModelElementsWithDefaultCategory
```
java.util.List<? extends IModelElement> getAllModelElementsWithDefaultCategory()
```
    Returns all model elements of this project that belong to the default category sorted by their type and element names.
    
    Returns:
    
    a list of all model elements of this project that belong to the default category (!=null)
  - getAllModelElementsWithDefaultCategory
```
java.util.List<? extends IModelElement> getAllModelElementsWithDefaultCategory(java.lang.String typeID)
```
    Returns all model elements of this project of the specified type that belong to the default category sorted by their type and element names.
    
    Parameters:
    
    typeID - the type ID
    
    Returns:
    
    a list of all model elements of this project that belong to the default category (!=null)
  - filterModelElementsOfType
```
java.util.Collection<? extends IModelElement> filterModelElementsOfType(java.util.Collection<IModelElement> modelElements,
                                                                        java.lang.String typeID)
```
    Returns all model elements of the given collection, which are of the specified type.
    
    The given collection is not modified. The model elements remain in the order they have in the given collection. The supported model element types including their typeID can be retrieved from the IProjectDataProvider.
    
    Parameters:
    
    modelElements - the collection of model elements
    
    typeID - the type id
    
    Returns:
    
    all model elements of the given collection, which are of the specified type (!=null)
  - getRootModelElementsOfContainmentRelationship
```
java.util.List<? extends IModelElement> getRootModelElementsOfContainmentRelationship()
```
    Returns all model elements of the selected project, which are root elements of the containment relationship, i.e. which are not contained in any other model element. The model elements are returned sorted by their type and element names.
    
    Returns:
    
    a list of all model elements of the selected project, which are root elements of the containment relationship (!=null)
  - getRootModelElementsOfCausalityRelationship
```
java.util.List<? extends IModelElement> getRootModelElementsOfCausalityRelationship()
```
    Returns all model elements of the selected project, which are root elements of the causality relationship, i.e. for which no causally preceding model element exists. The model elements are returned sorted by their type and element names.
    
    Returns:
    
    a list of all model elements of the selected project, which are root elements of the causality relationship (!=null)
  - getLeafModelElementsOfContainmentRelationship
```
java.util.List<? extends IModelElement> getLeafModelElementsOfContainmentRelationship()
```
    Returns all model elements of the selected project, which are leaf elements of the containment relationship, i.e. which do not contain any other model element. The model elements are returned sorted by their type and element names.
    
    Returns:
    
    a list of all model elements of the selected project, which are leaf elements of the containment relationship (!=null)
  - getLeafModelElementsOfCausalityRelationship
```
java.util.List<? extends IModelElement> getLeafModelElementsOfCausalityRelationship()
```
    Returns all model elements of the selected project, which are leaf elements of the causality relationship, i.e. which are not causally preceding any other model element. The model elements are returned sorted by their type and element names.
    
    Returns:
    
    a list of all model elements of the selected project, which are leaf elements of the causality relationship (!=null)
  - getProjectHistoryEntries
```
java.util.List<? extends IHistoryEntry> getProjectHistoryEntries()
```
    Returns all entries of the project's history.
    Each time, a user commits the project, a history entry is created. User, date and comment are logged. This is requestable by this function.
    Note: This list is filled in Cockpit enterprise edition (client/ server). Cockpit Professional (standalone) does not manage a project history, and therefore the returned list is empty.
    
    Returns:
    
    all history entries (empty in standalone)
  - getAllPlansForHistoryItem
```
java.util.List<? extends IPlan> getAllPlansForHistoryItem(IHistoryEntry historyEntry)
```
    Returns all 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 plan is only assigned to the history item for the commit of the last change of the plan. This method does not allow to access old versions.
    
    Parameters:
    
    historyEntry - history item identifying the last change of the plans
    
    Returns:
    
    all plans modified the last time with the given history item
  - getAllFoldersForHistoryItem
```
java.util.List<? extends IFolder> getAllFoldersForHistoryItem(IHistoryEntry historyEntry)
```
    Returns all folders 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 folder is only assigned to the history item for the commit of the last change of the folder. This method does not allow to access old versions.
    
    Parameters:
    
    historyEntry - history item identifying the last change of the plans
    
    Returns:
    
    all folders modified the last time with the given history item
  - getAllModelElementsForHistoryItem
```
java.util.List<? extends IModelElement> getAllModelElementsForHistoryItem(IHistoryEntry historyEntry)
```
    Returns all model elements 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 model element is only assigned to the history item for the commit of the last change of the model element. This method does not allow to access old versions.
    
    Parameters:
    
    historyEntry - history item identifying the last change of the plans
    
    Returns:
    
    all model elements modified the last time with the given history item
  - getAllStakeholdersForHistoryItem
```
java.util.List<? extends IStakeholder> getAllStakeholdersForHistoryItem(IHistoryEntry historyEntry)
```
    Returns all Stakeholders 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 Stakeholder is only assigned to the history item for the commit of the last change of the Stakeholder. This method does not allow to access old versions.
    
    Parameters:
    
    historyEntry - history item identifying the last change of the plans
    
    Returns:
    
    all Stakeholders modified the last time with the given history item
  - getAllStakeholderRolesForHistoryItem
```
java.util.List<? extends IStakeholderRole> getAllStakeholderRolesForHistoryItem(IHistoryEntry historyEntry)
```
    Returns all Stakeholder Roles 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 Stakeholder Role is only assigned to the history item for the commit of the last change of the Stakeholder Role. This method does not allow to access old versions.
    
    Parameters:
    
    historyEntry - history item identifying the last change of the plans
    
    Returns:
    
    all Stakeholder Roles modified the last time with the given history item
  - getLabelForUID
```
java.lang.String getLabelForUID(java.lang.String uid)
```
    Returns a label for the object with the specified unique identifier.
    
    Parameters:
    
    uid - the unique identifier
    
    Returns:
    
    a label (null if not found)
  - toRecord
```
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 ICockpitData
    
    Specified by:
    
    toRecord in interface ICustomPropertiesAccess
    
    Returns:
    
    converted cockpit project data

Interface IProject

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

getLogo

getLanguage

getRootFolders

getRootFoldersWithCategory

getRootFoldersWithDefaultCategory

getRootPlans

findFolder

getAllPlans

getAllPlansInDefinedOrder

getAllStakeholders

getAllStakeholdersWithCategory

getAllStakeholdersWithDefaultCategory

getStakeholderForCurrentUser

getAllStakeholderRoles

getAllStakeholderRolesWithCategory

getAllStakeholderRolesWithDefaultCategory

getStakeholderRole

getAllModelElements

getAllModelElements

getAllModelElementsWithCategory

getAllModelElementsWithCategory

getAllModelElementsWithDefaultCategory

getAllModelElementsWithDefaultCategory

filterModelElementsOfType

getRootModelElementsOfContainmentRelationship

getRootModelElementsOfCausalityRelationship

getLeafModelElementsOfContainmentRelationship

getLeafModelElementsOfCausalityRelationship

getProjectHistoryEntries

getAllPlansForHistoryItem

getAllFoldersForHistoryItem

getAllModelElementsForHistoryItem

getAllStakeholdersForHistoryItem

getAllStakeholderRolesForHistoryItem

getLabelForUID

toRecord