IProjectDataProvider

```
public interface IProjectDataProvider
```
The IProjectDataProvider allows to access objects of a COCKPIT project for document generation. The IProjectDataProvider can be referenced directly within a document template by its name projectDataProvider.
Further elements in the context are:
$outputFormatId: the id of the chosen output format (ASCII_DOCUMENT, DOCBOOK_XML, HTML_DOCUMENT, ODT_DOCUMENT, WORD_DOCUMENT, WORDML_DOCUMENT, PDF_DOCUMENT, ANALYSE_DOCUMENT, ...)
$outputTemplateName: as defined in the report output template
$outputTemplateDescription: as defined in the report output template
$pageSizeHint.getPreferredWidthInMM(): as defined in the report output template
$pageSizeHint.getPreferredHeightInMM(): as defined in the report output template
$logger: see ILogger
$reportController: see IReportController
$javaMath: see Math

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IElementPresentationRule`	`createElementPresentationRule()` Creates an element presentation rule to be used e.g. for `IPlanPresentationRule.setElementPresentationRules(java.util.Map)` Use `ArrayHelper.createHashMap()` to create presentation rule maps.
`ILink`	`createLink(java.lang.String href, java.lang.String title, java.lang.String show, java.lang.String target)` Creates a link to be used e.g. for `IGraphic#getSVGFile(java.util.Map)` Use `ArrayHelper.createHashMap()` to create link maps.
`IPlanPresentationRule`	`createPlanPresentationRule()` Creates an plan presentation rule to be used e.g. for `IGraphic#getImage(IPlanPresentationRule)`
`java.lang.String`	`generateUID()` Generates a UID.
`java.util.Collection<IModelElementTypeDescription>`	`getModelElementTypes()` Returns a list of description elements for the supported model element types.
`IProject`	`getProject()` Returns the project root node.

- Method Detail
  - getProject
```
IProject getProject()
```
    Returns the project root node.
    Returns the IProject representing the root object of the project, which allows for access to the project meta data as well as the root entities of a COCKPIT project (like root sections and plans).
    
    Example from report template:
    
    #set($project = ${projectDataProvider.Project}) or
    
    #set($project = ${projectDataProvider.getProject())}
    
    Returns:
    
    the root object of a COCKPIT project
  - getModelElementTypes
```
java.util.Collection<IModelElementTypeDescription> getModelElementTypes()
```
    Returns a list of description elements for the supported model element types. The description elements can be used to get the type name in singular and plural form.
    
    Returns:
    
    the descriptions of all supported model element types
  - createLink
```
ILink createLink(java.lang.String href,
                 java.lang.String title,
                 java.lang.String show,
                 java.lang.String target)
```
    Creates a link to be used e.g. for IGraphic#getSVGFile(java.util.Map)
    Use ArrayHelper.createHashMap() to create link maps.
    
    Parameters:
    
    href - see IElementPresentationRule#getHRef()
    
    title - see IElementPresentationRule#getTitle()
    
    show - see IElementPresentationRule#getShow()
    
    target - see IElementPresentationRule#getTarget()
    
    Returns:
    
    the created link (never null)
  - createPlanPresentationRule
```
IPlanPresentationRule createPlanPresentationRule()
```
    Creates an plan presentation rule to be used e.g. for IGraphic#getImage(IPlanPresentationRule)
    
    Returns:
    
    the created plan presentation rule (never null)
  - createElementPresentationRule
```
IElementPresentationRule createElementPresentationRule()
```
    Creates an element presentation rule to be used e.g. for IPlanPresentationRule.setElementPresentationRules(java.util.Map)
    Use ArrayHelper.createHashMap() to create presentation rule maps.
    
    Returns:
    
    the created element presentation rule (never null)
  - generateUID
```
java.lang.String generateUID()
```
    Generates a UID.
    
    Returns:
    
    uid

Interface IProjectDataProvider

Method Summary

Method Detail

getProject

getModelElementTypes

createLink

createPlanPresentationRule

createElementPresentationRule

generateUID