IReportDataProvider

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IReportSet`	`findReportSet(java.lang.String path)` Searches for the report set item with the specified path.
`ISourceSet`	`findSourceSet(java.lang.String path)` Searches for the source set item with the specified path.
`java.util.List<? extends IMacroDefinition>`	`getAllMacroDefinitions()` Returns all macro definition items of the project.
`java.util.List<? extends IMacroDefinition>`	`getAllMacroDefinitions(int sortingCriterion)` Returns all macro definition items of the project.
`java.util.List<? extends IMacroDefinition>`	`getAllMacroDefinitions(java.lang.String sortingProperty)` Returns all macro definition items of the project.
`java.util.List<? extends IMacroDefinition>`	`getAllMacroDefinitionsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)` Returns all macro definition items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).
`java.util.List<? extends IMacroDefinition>`	`getAllMacroDefinitionsWithCategory(java.lang.String categoryID)` Returns all macro definition items of the project that belong to the specified category.
`java.util.List<? extends IMacroDefinition>`	`getAllMacroDefinitionsWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all macro definition items of the project that belong to the specified category.
`java.util.List<? extends IMacroDefinition>`	`getAllMacroDefinitionsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all macro definition items of the project that belong to the specified category.
`java.util.List<? extends IMacroDefinition>`	`getAllMacroDefinitionsWithDefaultCategory()` Returns all macro definition items of the project that belong to the default category.
`java.util.List<? extends IMacroDefinition>`	`getAllMacroDefinitionsWithDefaultCategory(int sortingCriterion)` Returns all macro definition items of the project that belong to the default category.
`java.util.List<? extends IMacroDefinition>`	`getAllMacroDefinitionsWithDefaultCategory(java.lang.String sortingProperty)` Returns all macro definition items of the project that belong to the default category.
`java.util.List<? extends IReportConfiguration>`	`getAllReportConfigurations()` Returns all report configuration items of the project.
`java.util.List<? extends IReportConfiguration>`	`getAllReportConfigurations(int sortingCriterion)` Returns all report configuration items of the project.
`java.util.List<? extends IReportConfiguration>`	`getAllReportConfigurations(java.lang.String sortingProperty)` Returns all report configuration items of the project.
`java.util.List<? extends IReportConfiguration>`	`getAllReportConfigurationsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)` Returns all report configuration items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).
`java.util.List<? extends IReportConfiguration>`	`getAllReportConfigurationsWithCategory(java.lang.String categoryID)` Returns all report configuration items of the project that belong to the specified category.
`java.util.List<? extends IReportConfiguration>`	`getAllReportConfigurationsWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all report configuration items of the project that belong to the specified category.
`java.util.List<? extends IReportConfiguration>`	`getAllReportConfigurationsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all report configuration items of the project that belong to the specified category.
`java.util.List<? extends IReportConfiguration>`	`getAllReportConfigurationsWithDefaultCategory()` Returns all report configuration items of the project that belong to the default category.
`java.util.List<? extends IReportConfiguration>`	`getAllReportConfigurationsWithDefaultCategory(int sortingCriterion)` Returns all report configuration items of the project that belong to the default category.
`java.util.List<? extends IReportConfiguration>`	`getAllReportConfigurationsWithDefaultCategory(java.lang.String sortingProperty)` Returns all report configuration items of the project that belong to the default category.
`java.util.List<? extends IReport>`	`getAllReports()` Returns all report items of the project.
`java.util.List<? extends IReport>`	`getAllReports(int sortingCriterion)` Returns all report items of the project.
`java.util.List<? extends IReport>`	`getAllReports(java.lang.String sortingProperty)` Returns all report items of the project.
`java.util.List<? extends IReportSet>`	`getAllReportSets()` Returns all report set items of the project.
`java.util.List<? extends IReportSet>`	`getAllReportSets(int sortingCriterion)` Returns all report set items of the project.
`java.util.List<? extends IReportSet>`	`getAllReportSets(java.lang.String sortingProperty)` Returns all report set items of the project.
`java.util.List<? extends IReportSet>`	`getAllReportSetsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)` Returns all report set items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).
`java.util.List<? extends IReportSet>`	`getAllReportSetsWithCategory(java.lang.String categoryID)` Returns all report set items of the project that belong to the specified category.
`java.util.List<? extends IReportSet>`	`getAllReportSetsWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all report set items of the project that belong to the specified category.
`java.util.List<? extends IReportSet>`	`getAllReportSetsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all report set items of the project that belong to the specified category.
`java.util.List<? extends IReportSet>`	`getAllReportSetsWithDefaultCategory()` Returns all report set items of the project that belong to the default category.
`java.util.List<? extends IReportSet>`	`getAllReportSetsWithDefaultCategory(int sortingCriterion)` Returns all report set items of the project that belong to the default category.
`java.util.List<? extends IReportSet>`	`getAllReportSetsWithDefaultCategory(java.lang.String sortingProperty)` Returns all report set items of the project that belong to the default category.
`java.util.List<? extends IReport>`	`getAllReportsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)` Returns all report items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).
`java.util.List<? extends IReport>`	`getAllReportsWithCategory(java.lang.String categoryID)` Returns all report items of the project that belong to the specified category.
`java.util.List<? extends IReport>`	`getAllReportsWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all report items of the project that belong to the specified category.
`java.util.List<? extends IReport>`	`getAllReportsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all report items of the project that belong to the specified category.
`java.util.List<? extends IReport>`	`getAllReportsWithDefaultCategory()` Returns all report items of the project that belong to the default category.
`java.util.List<? extends IReport>`	`getAllReportsWithDefaultCategory(int sortingCriterion)` Returns all report items of the project that belong to the default category.
`java.util.List<? extends IReport>`	`getAllReportsWithDefaultCategory(java.lang.String sortingProperty)` Returns all report items of the project that belong to the default category.
`java.util.List<? extends IMacroDefinition>`	`getAllRootMacroDefinitions()` Returns all root macro definition items of the project.
`java.util.List<? extends IMacroDefinition>`	`getAllRootMacroDefinitions(int sortingCriterion)` Returns all root macro definition items of the project.
`java.util.List<? extends IMacroDefinition>`	`getAllRootMacroDefinitions(java.lang.String sortingProperty)` Returns all root macro definition items of the project.
`java.util.List<? extends IMacroDefinition>`	`getAllRootMacroDefinitionsWithCategory(java.lang.String categoryID)` Returns all root macro definition items of the project that belong to the specified category.
`java.util.List<? extends IMacroDefinition>`	`getAllRootMacroDefinitionsWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all root macro definition items of the project that belong to the specified category.
`java.util.List<? extends IMacroDefinition>`	`getAllRootMacroDefinitionsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all root macro definition items of the project that belong to the specified category.
`java.util.List<? extends IMacroDefinition>`	`getAllRootMacroDefinitionsWithDefaultCategory()` Returns all root macro definition items of the project that belong to the default category.
`java.util.List<? extends IMacroDefinition>`	`getAllRootMacroDefinitionsWithDefaultCategory(int sortingCriterion)` Returns all root macro definition items of the project that belong to the default category.
`java.util.List<? extends IMacroDefinition>`	`getAllRootMacroDefinitionsWithDefaultCategory(java.lang.String sortingProperty)` Returns all root macro definition items of the project that belong to the default category.
`java.util.List<? extends IReport>`	`getAllRootReports()` Returns all root report items of the project.
`java.util.List<? extends IReport>`	`getAllRootReports(int sortingCriterion)` Returns all root report items of the project.
`java.util.List<? extends IReport>`	`getAllRootReports(java.lang.String sortingProperty)` Returns all root report items of the project.
`java.util.List<? extends IReportSet>`	`getAllRootReportSets()` Returns all root report set items of the project.
`java.util.List<? extends IReportSet>`	`getAllRootReportSets(int sortingCriterion)` Returns all root report set items of the project.
`java.util.List<? extends IReportSet>`	`getAllRootReportSets(java.lang.String sortingProperty)` Returns all root report set items of the project.
`java.util.List<? extends IReportSet>`	`getAllRootReportSetsWithCategory(java.lang.String categoryID)` Returns all root report set items of the project that belong to the specified category.
`java.util.List<? extends IReportSet>`	`getAllRootReportSetsWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all root report set items of the project that belong to the specified category.
`java.util.List<? extends IReportSet>`	`getAllRootReportSetsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all root report set items of the project that belong to the specified category.
`java.util.List<? extends IReportSet>`	`getAllRootReportSetsWithDefaultCategory()` Returns all root report set items of the project that belong to the default category.
`java.util.List<? extends IReportSet>`	`getAllRootReportSetsWithDefaultCategory(int sortingCriterion)` Returns all root report set items of the project that belong to the default category.
`java.util.List<? extends IReportSet>`	`getAllRootReportSetsWithDefaultCategory(java.lang.String sortingProperty)` Returns all root report set items of the project that belong to the default category.
`java.util.List<? extends IReport>`	`getAllRootReportsWithCategory(java.lang.String categoryID)` Returns all root report items of the project that belong to the specified category.
`java.util.List<? extends IReport>`	`getAllRootReportsWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all root report items of the project that belong to the specified category.
`java.util.List<? extends IReport>`	`getAllRootReportsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all root report items of the project that belong to the specified category.
`java.util.List<? extends IReport>`	`getAllRootReportsWithDefaultCategory()` Returns all root report items of the project that belong to the default category.
`java.util.List<? extends IReport>`	`getAllRootReportsWithDefaultCategory(int sortingCriterion)` Returns all root report items of the project that belong to the default category.
`java.util.List<? extends IReport>`	`getAllRootReportsWithDefaultCategory(java.lang.String sortingProperty)` Returns all root report items of the project that belong to the default category.
`java.util.List<? extends IScript>`	`getAllRootScripts()` Returns all root script items of the project.
`java.util.List<? extends IScript>`	`getAllRootScripts(int sortingCriterion)` Returns all root script items of the project.
`java.util.List<? extends IScript>`	`getAllRootScripts(java.lang.String sortingProperty)` Returns all root script items of the project.
`java.util.List<? extends IScript>`	`getAllRootScriptsWithCategory(java.lang.String categoryID)` Returns all root script items of the project that belong to the specified category.
`java.util.List<? extends IScript>`	`getAllRootScriptsWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all root script items of the project that belong to the specified category.
`java.util.List<? extends IScript>`	`getAllRootScriptsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all root script items of the project that belong to the specified category.
`java.util.List<? extends IScript>`	`getAllRootScriptsWithDefaultCategory()` Returns all root script items of the project that belong to the default category.
`java.util.List<? extends IScript>`	`getAllRootScriptsWithDefaultCategory(int sortingCriterion)` Returns all root script items of the project that belong to the default category.
`java.util.List<? extends IScript>`	`getAllRootScriptsWithDefaultCategory(java.lang.String sortingProperty)` Returns all root script items of the project that belong to the default category.
`java.util.List<? extends ISourceSet>`	`getAllRootSourceSets()` Returns all root source set items of the project.
`java.util.List<? extends ISourceSet>`	`getAllRootSourceSets(int sortingCriterion)` Returns all root source set items of the project.
`java.util.List<? extends ISourceSet>`	`getAllRootSourceSets(java.lang.String sortingProperty)` Returns all root source set items of the project.
`java.util.List<? extends ISourceSet>`	`getAllRootSourceSetsWithCategory(java.lang.String categoryID)` Returns all root source set items of the project that belong to the specified category.
`java.util.List<? extends ISourceSet>`	`getAllRootSourceSetsWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all root source set items of the project that belong to the specified category.
`java.util.List<? extends ISourceSet>`	`getAllRootSourceSetsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all root source set items of the project that belong to the specified category.
`java.util.List<? extends ISourceSet>`	`getAllRootSourceSetsWithDefaultCategory()` Returns all root source set items of the project that belong to the default category.
`java.util.List<? extends ISourceSet>`	`getAllRootSourceSetsWithDefaultCategory(int sortingCriterion)` Returns all root source set items of the project that belong to the default category.
`java.util.List<? extends ISourceSet>`	`getAllRootSourceSetsWithDefaultCategory(java.lang.String sortingProperty)` Returns all root source set items of the project that belong to the default category.
`java.util.List<? extends IScript>`	`getAllScripts()` Returns all script items of the project.
`java.util.List<? extends IScript>`	`getAllScripts(int sortingCriterion)` Returns all script items of the project.
`java.util.List<? extends IScript>`	`getAllScripts(java.lang.String sortingProperty)` Returns all script items of the project.
`java.util.List<? extends IScript>`	`getAllScriptsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)` Returns all script items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).
`java.util.List<? extends IScript>`	`getAllScriptsWithCategory(java.lang.String categoryID)` Returns all script items of the project that belong to the specified category.
`java.util.List<? extends IScript>`	`getAllScriptsWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all script items of the project that belong to the specified category.
`java.util.List<? extends IScript>`	`getAllScriptsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all script items of the project that belong to the specified category.
`java.util.List<? extends IScript>`	`getAllScriptsWithDefaultCategory()` Returns all script items of the project that belong to the default category.
`java.util.List<? extends IScript>`	`getAllScriptsWithDefaultCategory(int sortingCriterion)` Returns all script items of the project that belong to the default category.
`java.util.List<? extends IScript>`	`getAllScriptsWithDefaultCategory(java.lang.String sortingProperty)` Returns all script items of the project that belong to the default category.
`java.util.List<? extends ISourceSet>`	`getAllSourceSets()` Returns all source set items of the project.
`java.util.List<? extends ISourceSet>`	`getAllSourceSets(int sortingCriterion)` Returns all source set items of the project.
`java.util.List<? extends ISourceSet>`	`getAllSourceSets(java.lang.String sortingProperty)` Returns all source set items of the project.
`java.util.List<? extends ISourceSet>`	`getAllSourceSetsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)` Returns all source set items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).
`java.util.List<? extends ISourceSet>`	`getAllSourceSetsWithCategory(java.lang.String categoryID)` Returns all source set items of the project that belong to the specified category.
`java.util.List<? extends ISourceSet>`	`getAllSourceSetsWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all source set items of the project that belong to the specified category.
`java.util.List<? extends ISourceSet>`	`getAllSourceSetsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all source set items of the project that belong to the specified category.
`java.util.List<? extends ISourceSet>`	`getAllSourceSetsWithDefaultCategory()` Returns all source set items of the project that belong to the default category.
`java.util.List<? extends ISourceSet>`	`getAllSourceSetsWithDefaultCategory(int sortingCriterion)` Returns all source set items of the project that belong to the default category.
`java.util.List<? extends ISourceSet>`	`getAllSourceSetsWithDefaultCategory(java.lang.String sortingProperty)` Returns all source set items of the project that belong to the default category.
`int`	`getSORT_MACRODEFINITION_BY_ID()` Constant for sorting macro definition items by id.
`int`	`getSORT_MACRODEFINITION_BY_IDANDTITLE()` Constant for sorting macro definition items by id and title.
`int`	`getSORT_MACRODEFINITION_BY_TITLE()` Constant for sorting macro definition items by title.
`int`	`getSORT_REPORT_BY_ID()` Constant for sorting report items by id.
`int`	`getSORT_REPORT_BY_IDANDTITLE()` Constant for sorting report items by id and title.
`int`	`getSORT_REPORT_BY_TITLE()` Constant for sorting report items by title.
`int`	`getSORT_REPORTCONFIGURATION_BY_NAME()` Constant for sorting report configuration items by name.
`int`	`getSORT_REPORTSET_BY_NAME()` Constant for sorting report set items by name.
`int`	`getSORT_SCRIPT_BY_ID()` Constant for sorting script items by id.
`int`	`getSORT_SCRIPT_BY_IDANDTITLE()` Constant for sorting script items by id and title.
`int`	`getSORT_SCRIPT_BY_TITLE()` Constant for sorting script items by title.
`int`	`getSORT_SOURCESET_BY_NAME()` Constant for sorting source set items by name.

- Method Detail
  - getSORT_REPORTSET_BY_NAME
```
int getSORT_REPORTSET_BY_NAME()
```
    Constant for sorting report set items by name.
    
    Returns:
    
    constant for sorting report set items by name
  - getSORT_REPORT_BY_ID
```
int getSORT_REPORT_BY_ID()
```
    Constant for sorting report items by id.
    
    Returns:
    
    constant for sorting report items by id
  - getSORT_REPORT_BY_TITLE
```
int getSORT_REPORT_BY_TITLE()
```
    Constant for sorting report items by title.
    
    Returns:
    
    constant for sorting report items by title
  - getSORT_REPORT_BY_IDANDTITLE
```
int getSORT_REPORT_BY_IDANDTITLE()
```
    Constant for sorting report items by id and title.
    
    Returns:
    
    constant for sorting report items by id and title
  - getSORT_REPORTCONFIGURATION_BY_NAME
```
int getSORT_REPORTCONFIGURATION_BY_NAME()
```
    Constant for sorting report configuration items by name.
    
    Returns:
    
    constant for sorting report configuration items by name
  - getSORT_SOURCESET_BY_NAME
```
int getSORT_SOURCESET_BY_NAME()
```
    Constant for sorting source set items by name.
    
    Returns:
    
    constant for sorting source set items by name
  - getSORT_MACRODEFINITION_BY_ID
```
int getSORT_MACRODEFINITION_BY_ID()
```
    Constant for sorting macro definition items by id.
    
    Returns:
    
    constant for sorting macro definition items by id
  - getSORT_MACRODEFINITION_BY_TITLE
```
int getSORT_MACRODEFINITION_BY_TITLE()
```
    Constant for sorting macro definition items by title.
    
    Returns:
    
    constant for sorting macro definition items by title
  - getSORT_MACRODEFINITION_BY_IDANDTITLE
```
int getSORT_MACRODEFINITION_BY_IDANDTITLE()
```
    Constant for sorting macro definition items by id and title.
    
    Returns:
    
    constant for sorting macro definition items by id and title
  - getSORT_SCRIPT_BY_ID
```
int getSORT_SCRIPT_BY_ID()
```
    Constant for sorting script items by id.
    
    Returns:
    
    constant for sorting script items by id
  - getSORT_SCRIPT_BY_TITLE
```
int getSORT_SCRIPT_BY_TITLE()
```
    Constant for sorting script items by title.
    
    Returns:
    
    constant for sorting script items by title
  - getSORT_SCRIPT_BY_IDANDTITLE
```
int getSORT_SCRIPT_BY_IDANDTITLE()
```
    Constant for sorting script items by id and title.
    
    Returns:
    
    constant for sorting script items by id and title
  - getAllReportSets
```
java.util.List<? extends IReportSet> getAllReportSets()
```
    Returns all report set items of the project.
    
    The report set items are sorted by name.
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllReportSets
```
java.util.List<? extends IReportSet> getAllReportSets(int sortingCriterion)
```
    Returns all report set items of the project.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllReportSets
```
java.util.List<? extends IReportSet> getAllReportSets(java.lang.String sortingProperty)
```
    Returns all report set items of the project.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllReportSetsWithCategory
```
java.util.List<? extends IReportSet> getAllReportSetsWithCategory(java.lang.String categoryID)
```
    Returns all report set items of the project that belong to the specified category.
    
    The report set items are sorted by name.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllReportSetsWithCategory
```
java.util.List<? extends IReportSet> getAllReportSetsWithCategory(java.lang.String categoryID,
                                                                  int sortingCriterion)
```
    Returns all report set items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllReportSetsWithCategory
```
java.util.List<? extends IReportSet> getAllReportSetsWithCategory(java.lang.String categoryID,
                                                                  java.lang.String sortingProperty)
```
    Returns all report set items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllReportSetsWithDefaultCategory
```
java.util.List<? extends IReportSet> getAllReportSetsWithDefaultCategory()
```
    Returns all report set items of the project that belong to the default category.
    
    The report set items are sorted by name.
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllReportSetsWithDefaultCategory
```
java.util.List<? extends IReportSet> getAllReportSetsWithDefaultCategory(int sortingCriterion)
```
    Returns all report set items of the project that belong to the default category.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllReportSetsWithDefaultCategory
```
java.util.List<? extends IReportSet> getAllReportSetsWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all report set items of the project that belong to the default category.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllRootReportSets
```
java.util.List<? extends IReportSet> getAllRootReportSets()
```
    Returns all root report set items of the project.
    
    The report set items are returned in their natural order.
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllRootReportSets
```
java.util.List<? extends IReportSet> getAllRootReportSets(int sortingCriterion)
```
    Returns all root report set items of the project.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllRootReportSets
```
java.util.List<? extends IReportSet> getAllRootReportSets(java.lang.String sortingProperty)
```
    Returns all root report set items of the project.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllRootReportSetsWithCategory
```
java.util.List<? extends IReportSet> getAllRootReportSetsWithCategory(java.lang.String categoryID)
```
    Returns all root report set items of the project that belong to the specified category.
    
    The report set items are returned in their natural order.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllRootReportSetsWithCategory
```
java.util.List<? extends IReportSet> getAllRootReportSetsWithCategory(java.lang.String categoryID,
                                                                      int sortingCriterion)
```
    Returns all root report set items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllRootReportSetsWithCategory
```
java.util.List<? extends IReportSet> getAllRootReportSetsWithCategory(java.lang.String categoryID,
                                                                      java.lang.String sortingProperty)
```
    Returns all root report set items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllRootReportSetsWithDefaultCategory
```
java.util.List<? extends IReportSet> getAllRootReportSetsWithDefaultCategory()
```
    Returns all root report set items of the project that belong to the default category.
    
    The report set items are returned in their natural order.
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllRootReportSetsWithDefaultCategory
```
java.util.List<? extends IReportSet> getAllRootReportSetsWithDefaultCategory(int sortingCriterion)
```
    Returns all root report set items of the project that belong to the default category.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllRootReportSetsWithDefaultCategory
```
java.util.List<? extends IReportSet> getAllRootReportSetsWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all root report set items of the project that belong to the default category.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IReportSet objects (!= null)
  - getAllReportSetsForHistoryItem
```
java.util.List<? extends IReportSet> getAllReportSetsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
```
    Returns all report set items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).
    Note: For the purpose of this method, the current version of an report set is only assigned to the history item for the commit of the last change of the report set. This method does not allow to access old versions.
    
    Parameters:
    
    historyItem - history item identifying the last change of the report set items
    
    Returns:
    
    all report set items modified the last time with the specified commit
  - getAllReports
```
java.util.List<? extends IReport> getAllReports()
```
    Returns all report items of the project.
    
    The report items are sorted by id and title.
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllReports
```
java.util.List<? extends IReport> getAllReports(int sortingCriterion)
```
    Returns all report items of the project.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllReports
```
java.util.List<? extends IReport> getAllReports(java.lang.String sortingProperty)
```
    Returns all report items of the project.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllReportsWithCategory
```
java.util.List<? extends IReport> getAllReportsWithCategory(java.lang.String categoryID)
```
    Returns all report items of the project that belong to the specified category.
    
    The report items are sorted by id and title.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllReportsWithCategory
```
java.util.List<? extends IReport> getAllReportsWithCategory(java.lang.String categoryID,
                                                            int sortingCriterion)
```
    Returns all report items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllReportsWithCategory
```
java.util.List<? extends IReport> getAllReportsWithCategory(java.lang.String categoryID,
                                                            java.lang.String sortingProperty)
```
    Returns all report items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllReportsWithDefaultCategory
```
java.util.List<? extends IReport> getAllReportsWithDefaultCategory()
```
    Returns all report items of the project that belong to the default category.
    
    The report items are sorted by id and title.
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllReportsWithDefaultCategory
```
java.util.List<? extends IReport> getAllReportsWithDefaultCategory(int sortingCriterion)
```
    Returns all report items of the project that belong to the default category.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllReportsWithDefaultCategory
```
java.util.List<? extends IReport> getAllReportsWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all report items of the project that belong to the default category.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllRootReports
```
java.util.List<? extends IReport> getAllRootReports()
```
    Returns all root report items of the project.
    
    The report items are returned in their natural order.
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllRootReports
```
java.util.List<? extends IReport> getAllRootReports(int sortingCriterion)
```
    Returns all root report items of the project.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllRootReports
```
java.util.List<? extends IReport> getAllRootReports(java.lang.String sortingProperty)
```
    Returns all root report items of the project.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllRootReportsWithCategory
```
java.util.List<? extends IReport> getAllRootReportsWithCategory(java.lang.String categoryID)
```
    Returns all root report items of the project that belong to the specified category.
    
    The report items are returned in their natural order.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllRootReportsWithCategory
```
java.util.List<? extends IReport> getAllRootReportsWithCategory(java.lang.String categoryID,
                                                                int sortingCriterion)
```
    Returns all root report items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllRootReportsWithCategory
```
java.util.List<? extends IReport> getAllRootReportsWithCategory(java.lang.String categoryID,
                                                                java.lang.String sortingProperty)
```
    Returns all root report items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllRootReportsWithDefaultCategory
```
java.util.List<? extends IReport> getAllRootReportsWithDefaultCategory()
```
    Returns all root report items of the project that belong to the default category.
    
    The report items are returned in their natural order.
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllRootReportsWithDefaultCategory
```
java.util.List<? extends IReport> getAllRootReportsWithDefaultCategory(int sortingCriterion)
```
    Returns all root report items of the project that belong to the default category.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllRootReportsWithDefaultCategory
```
java.util.List<? extends IReport> getAllRootReportsWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all root report items of the project that belong to the default category.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IReport objects (!= null)
  - getAllReportsForHistoryItem
```
java.util.List<? extends IReport> getAllReportsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
```
    Returns all report items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).
    Note: For the purpose of this method, the current version of an report is only assigned to the history item for the commit of the last change of the report. This method does not allow to access old versions.
    
    Parameters:
    
    historyItem - history item identifying the last change of the report items
    
    Returns:
    
    all report items modified the last time with the specified commit
  - getAllReportConfigurations
```
java.util.List<? extends IReportConfiguration> getAllReportConfigurations()
```
    Returns all report configuration items of the project.
    
    The report configuration items are sorted by name.
    
    Returns:
    
    list of IReportConfiguration objects (!= null)
  - getAllReportConfigurations
```
java.util.List<? extends IReportConfiguration> getAllReportConfigurations(int sortingCriterion)
```
    Returns all report configuration items of the project.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IReportConfiguration objects (!= null)
  - getAllReportConfigurations
```
java.util.List<? extends IReportConfiguration> getAllReportConfigurations(java.lang.String sortingProperty)
```
    Returns all report configuration items of the project.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IReportConfiguration objects (!= null)
  - getAllReportConfigurationsWithCategory
```
java.util.List<? extends IReportConfiguration> getAllReportConfigurationsWithCategory(java.lang.String categoryID)
```
    Returns all report configuration items of the project that belong to the specified category.
    
    The report configuration items are sorted by name.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of IReportConfiguration objects (!= null)
  - getAllReportConfigurationsWithCategory
```
java.util.List<? extends IReportConfiguration> getAllReportConfigurationsWithCategory(java.lang.String categoryID,
                                                                                      int sortingCriterion)
```
    Returns all report configuration items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IReportConfiguration objects (!= null)
  - getAllReportConfigurationsWithCategory
```
java.util.List<? extends IReportConfiguration> getAllReportConfigurationsWithCategory(java.lang.String categoryID,
                                                                                      java.lang.String sortingProperty)
```
    Returns all report configuration items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IReportConfiguration objects (!= null)
  - getAllReportConfigurationsWithDefaultCategory
```
java.util.List<? extends IReportConfiguration> getAllReportConfigurationsWithDefaultCategory()
```
    Returns all report configuration items of the project that belong to the default category.
    
    The report configuration items are sorted by name.
    
    Returns:
    
    list of IReportConfiguration objects (!= null)
  - getAllReportConfigurationsWithDefaultCategory
```
java.util.List<? extends IReportConfiguration> getAllReportConfigurationsWithDefaultCategory(int sortingCriterion)
```
    Returns all report configuration items of the project that belong to the default category.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IReportConfiguration objects (!= null)
  - getAllReportConfigurationsWithDefaultCategory
```
java.util.List<? extends IReportConfiguration> getAllReportConfigurationsWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all report configuration items of the project that belong to the default category.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IReportConfiguration objects (!= null)
  - getAllReportConfigurationsForHistoryItem
```
java.util.List<? extends IReportConfiguration> getAllReportConfigurationsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
```
    Returns all report configuration items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).
    Note: For the purpose of this method, the current version of an report configuration is only assigned to the history item for the commit of the last change of the report configuration. This method does not allow to access old versions.
    
    Parameters:
    
    historyItem - history item identifying the last change of the report configuration items
    
    Returns:
    
    all report configuration items modified the last time with the specified commit
  - getAllSourceSets
```
java.util.List<? extends ISourceSet> getAllSourceSets()
```
    Returns all source set items of the project.
    
    The source set items are sorted by name.
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllSourceSets
```
java.util.List<? extends ISourceSet> getAllSourceSets(int sortingCriterion)
```
    Returns all source set items of the project.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllSourceSets
```
java.util.List<? extends ISourceSet> getAllSourceSets(java.lang.String sortingProperty)
```
    Returns all source set items of the project.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllSourceSetsWithCategory
```
java.util.List<? extends ISourceSet> getAllSourceSetsWithCategory(java.lang.String categoryID)
```
    Returns all source set items of the project that belong to the specified category.
    
    The source set items are sorted by name.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllSourceSetsWithCategory
```
java.util.List<? extends ISourceSet> getAllSourceSetsWithCategory(java.lang.String categoryID,
                                                                  int sortingCriterion)
```
    Returns all source set items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllSourceSetsWithCategory
```
java.util.List<? extends ISourceSet> getAllSourceSetsWithCategory(java.lang.String categoryID,
                                                                  java.lang.String sortingProperty)
```
    Returns all source set items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllSourceSetsWithDefaultCategory
```
java.util.List<? extends ISourceSet> getAllSourceSetsWithDefaultCategory()
```
    Returns all source set items of the project that belong to the default category.
    
    The source set items are sorted by name.
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllSourceSetsWithDefaultCategory
```
java.util.List<? extends ISourceSet> getAllSourceSetsWithDefaultCategory(int sortingCriterion)
```
    Returns all source set items of the project that belong to the default category.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllSourceSetsWithDefaultCategory
```
java.util.List<? extends ISourceSet> getAllSourceSetsWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all source set items of the project that belong to the default category.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllRootSourceSets
```
java.util.List<? extends ISourceSet> getAllRootSourceSets()
```
    Returns all root source set items of the project.
    
    The source set items are returned in their natural order.
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllRootSourceSets
```
java.util.List<? extends ISourceSet> getAllRootSourceSets(int sortingCriterion)
```
    Returns all root source set items of the project.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllRootSourceSets
```
java.util.List<? extends ISourceSet> getAllRootSourceSets(java.lang.String sortingProperty)
```
    Returns all root source set items of the project.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllRootSourceSetsWithCategory
```
java.util.List<? extends ISourceSet> getAllRootSourceSetsWithCategory(java.lang.String categoryID)
```
    Returns all root source set items of the project that belong to the specified category.
    
    The source set items are returned in their natural order.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllRootSourceSetsWithCategory
```
java.util.List<? extends ISourceSet> getAllRootSourceSetsWithCategory(java.lang.String categoryID,
                                                                      int sortingCriterion)
```
    Returns all root source set items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllRootSourceSetsWithCategory
```
java.util.List<? extends ISourceSet> getAllRootSourceSetsWithCategory(java.lang.String categoryID,
                                                                      java.lang.String sortingProperty)
```
    Returns all root source set items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllRootSourceSetsWithDefaultCategory
```
java.util.List<? extends ISourceSet> getAllRootSourceSetsWithDefaultCategory()
```
    Returns all root source set items of the project that belong to the default category.
    
    The source set items are returned in their natural order.
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllRootSourceSetsWithDefaultCategory
```
java.util.List<? extends ISourceSet> getAllRootSourceSetsWithDefaultCategory(int sortingCriterion)
```
    Returns all root source set items of the project that belong to the default category.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllRootSourceSetsWithDefaultCategory
```
java.util.List<? extends ISourceSet> getAllRootSourceSetsWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all root source set items of the project that belong to the default category.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of ISourceSet objects (!= null)
  - getAllSourceSetsForHistoryItem
```
java.util.List<? extends ISourceSet> getAllSourceSetsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
```
    Returns all source set items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).
    Note: For the purpose of this method, the current version of an source set is only assigned to the history item for the commit of the last change of the source set. This method does not allow to access old versions.
    
    Parameters:
    
    historyItem - history item identifying the last change of the source set items
    
    Returns:
    
    all source set items modified the last time with the specified commit
  - getAllMacroDefinitions
```
java.util.List<? extends IMacroDefinition> getAllMacroDefinitions()
```
    Returns all macro definition items of the project.
    
    The macro definition items are sorted by id and title.
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllMacroDefinitions
```
java.util.List<? extends IMacroDefinition> getAllMacroDefinitions(int sortingCriterion)
```
    Returns all macro definition items of the project.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllMacroDefinitions
```
java.util.List<? extends IMacroDefinition> getAllMacroDefinitions(java.lang.String sortingProperty)
```
    Returns all macro definition items of the project.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllMacroDefinitionsWithCategory
```
java.util.List<? extends IMacroDefinition> getAllMacroDefinitionsWithCategory(java.lang.String categoryID)
```
    Returns all macro definition items of the project that belong to the specified category.
    
    The macro definition items are sorted by id and title.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllMacroDefinitionsWithCategory
```
java.util.List<? extends IMacroDefinition> getAllMacroDefinitionsWithCategory(java.lang.String categoryID,
                                                                              int sortingCriterion)
```
    Returns all macro definition items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllMacroDefinitionsWithCategory
```
java.util.List<? extends IMacroDefinition> getAllMacroDefinitionsWithCategory(java.lang.String categoryID,
                                                                              java.lang.String sortingProperty)
```
    Returns all macro definition items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllMacroDefinitionsWithDefaultCategory
```
java.util.List<? extends IMacroDefinition> getAllMacroDefinitionsWithDefaultCategory()
```
    Returns all macro definition items of the project that belong to the default category.
    
    The macro definition items are sorted by id and title.
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllMacroDefinitionsWithDefaultCategory
```
java.util.List<? extends IMacroDefinition> getAllMacroDefinitionsWithDefaultCategory(int sortingCriterion)
```
    Returns all macro definition items of the project that belong to the default category.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllMacroDefinitionsWithDefaultCategory
```
java.util.List<? extends IMacroDefinition> getAllMacroDefinitionsWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all macro definition items of the project that belong to the default category.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllRootMacroDefinitions
```
java.util.List<? extends IMacroDefinition> getAllRootMacroDefinitions()
```
    Returns all root macro definition items of the project.
    
    The macro definition items are returned in their natural order.
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllRootMacroDefinitions
```
java.util.List<? extends IMacroDefinition> getAllRootMacroDefinitions(int sortingCriterion)
```
    Returns all root macro definition items of the project.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllRootMacroDefinitions
```
java.util.List<? extends IMacroDefinition> getAllRootMacroDefinitions(java.lang.String sortingProperty)
```
    Returns all root macro definition items of the project.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllRootMacroDefinitionsWithCategory
```
java.util.List<? extends IMacroDefinition> getAllRootMacroDefinitionsWithCategory(java.lang.String categoryID)
```
    Returns all root macro definition items of the project that belong to the specified category.
    
    The macro definition items are returned in their natural order.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllRootMacroDefinitionsWithCategory
```
java.util.List<? extends IMacroDefinition> getAllRootMacroDefinitionsWithCategory(java.lang.String categoryID,
                                                                                  int sortingCriterion)
```
    Returns all root macro definition items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllRootMacroDefinitionsWithCategory
```
java.util.List<? extends IMacroDefinition> getAllRootMacroDefinitionsWithCategory(java.lang.String categoryID,
                                                                                  java.lang.String sortingProperty)
```
    Returns all root macro definition items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllRootMacroDefinitionsWithDefaultCategory
```
java.util.List<? extends IMacroDefinition> getAllRootMacroDefinitionsWithDefaultCategory()
```
    Returns all root macro definition items of the project that belong to the default category.
    
    The macro definition items are returned in their natural order.
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllRootMacroDefinitionsWithDefaultCategory
```
java.util.List<? extends IMacroDefinition> getAllRootMacroDefinitionsWithDefaultCategory(int sortingCriterion)
```
    Returns all root macro definition items of the project that belong to the default category.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllRootMacroDefinitionsWithDefaultCategory
```
java.util.List<? extends IMacroDefinition> getAllRootMacroDefinitionsWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all root macro definition items of the project that belong to the default category.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IMacroDefinition objects (!= null)
  - getAllMacroDefinitionsForHistoryItem
```
java.util.List<? extends IMacroDefinition> getAllMacroDefinitionsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
```
    Returns all macro definition items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).
    Note: For the purpose of this method, the current version of an macro definition is only assigned to the history item for the commit of the last change of the macro definition. This method does not allow to access old versions.
    
    Parameters:
    
    historyItem - history item identifying the last change of the macro definition items
    
    Returns:
    
    all macro definition items modified the last time with the specified commit
  - getAllScripts
```
java.util.List<? extends IScript> getAllScripts()
```
    Returns all script items of the project.
    
    The script items are sorted by id and title.
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllScripts
```
java.util.List<? extends IScript> getAllScripts(int sortingCriterion)
```
    Returns all script items of the project.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllScripts
```
java.util.List<? extends IScript> getAllScripts(java.lang.String sortingProperty)
```
    Returns all script items of the project.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllScriptsWithCategory
```
java.util.List<? extends IScript> getAllScriptsWithCategory(java.lang.String categoryID)
```
    Returns all script items of the project that belong to the specified category.
    
    The script items are sorted by id and title.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllScriptsWithCategory
```
java.util.List<? extends IScript> getAllScriptsWithCategory(java.lang.String categoryID,
                                                            int sortingCriterion)
```
    Returns all script items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllScriptsWithCategory
```
java.util.List<? extends IScript> getAllScriptsWithCategory(java.lang.String categoryID,
                                                            java.lang.String sortingProperty)
```
    Returns all script items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllScriptsWithDefaultCategory
```
java.util.List<? extends IScript> getAllScriptsWithDefaultCategory()
```
    Returns all script items of the project that belong to the default category.
    
    The script items are sorted by id and title.
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllScriptsWithDefaultCategory
```
java.util.List<? extends IScript> getAllScriptsWithDefaultCategory(int sortingCriterion)
```
    Returns all script items of the project that belong to the default category.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllScriptsWithDefaultCategory
```
java.util.List<? extends IScript> getAllScriptsWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all script items of the project that belong to the default category.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllRootScripts
```
java.util.List<? extends IScript> getAllRootScripts()
```
    Returns all root script items of the project.
    
    The script items are returned in their natural order.
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllRootScripts
```
java.util.List<? extends IScript> getAllRootScripts(int sortingCriterion)
```
    Returns all root script items of the project.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllRootScripts
```
java.util.List<? extends IScript> getAllRootScripts(java.lang.String sortingProperty)
```
    Returns all root script items of the project.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllRootScriptsWithCategory
```
java.util.List<? extends IScript> getAllRootScriptsWithCategory(java.lang.String categoryID)
```
    Returns all root script items of the project that belong to the specified category.
    
    The script items are returned in their natural order.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllRootScriptsWithCategory
```
java.util.List<? extends IScript> getAllRootScriptsWithCategory(java.lang.String categoryID,
                                                                int sortingCriterion)
```
    Returns all root script items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllRootScriptsWithCategory
```
java.util.List<? extends IScript> getAllRootScriptsWithCategory(java.lang.String categoryID,
                                                                java.lang.String sortingProperty)
```
    Returns all root script items of the project that belong to the specified category.
    
    Parameters:
    
    categoryID - the category ID
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllRootScriptsWithDefaultCategory
```
java.util.List<? extends IScript> getAllRootScriptsWithDefaultCategory()
```
    Returns all root script items of the project that belong to the default category.
    
    The script items are returned in their natural order.
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllRootScriptsWithDefaultCategory
```
java.util.List<? extends IScript> getAllRootScriptsWithDefaultCategory(int sortingCriterion)
```
    Returns all root script items of the project that belong to the default category.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllRootScriptsWithDefaultCategory
```
java.util.List<? extends IScript> getAllRootScriptsWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all root script items of the project that belong to the default category.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IScript objects (!= null)
  - getAllScriptsForHistoryItem
```
java.util.List<? extends IScript> getAllScriptsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
```
    Returns all script items which have been modified the last time with the commit identified by the given history item (each time, a user commits the project, a history item is created).
    Note: For the purpose of this method, the current version of an script is only assigned to the history item for the commit of the last change of the script. This method does not allow to access old versions.
    
    Parameters:
    
    historyItem - history item identifying the last change of the script items
    
    Returns:
    
    all script items modified the last time with the specified commit
  - findReportSet
```
IReportSet findReportSet(java.lang.String path)
```
    Searches for the report set item with the specified path. A path is a "/" separated list of report set names (e.g. "foo1/foo1.2" means "foo1.2" as child report set of "foo1").
    
    If a report set name contains a slash ("/"), than the slash must be replaced by a double slash ("//"). Attention: Slashes at the beginning of a report set name are not supported, because "foo1///foo2" would be interpreted as: "foo2" as a child of "foo1/".
    
    Attention: Only report set items which pass the filter must be contained in the path.
    
    Parameters:
    
    path - the path
    
    Returns:
    
    the report set specified by the path if found, null otherwise
  - findSourceSet
```
ISourceSet findSourceSet(java.lang.String path)
```
    Searches for the source set item with the specified path. A path is a "/" separated list of source set names (e.g. "foo1/foo1.2" means "foo1.2" as child source set of "foo1").
    
    If a source set name contains a slash ("/"), than the slash must be replaced by a double slash ("//"). Attention: Slashes at the beginning of a source set name are not supported, because "foo1///foo2" would be interpreted as: "foo2" as a child of "foo1/".
    
    Attention: Only source set items which pass the filter must be contained in the path.
    
    Parameters:
    
    path - the path
    
    Returns:
    
    the source set specified by the path if found, null otherwise

Interface IReportDataProvider

Method Summary

Method Detail

getSORT_REPORTSET_BY_NAME

getSORT_REPORT_BY_ID

getSORT_REPORT_BY_TITLE

getSORT_REPORT_BY_IDANDTITLE

getSORT_REPORTCONFIGURATION_BY_NAME

getSORT_SOURCESET_BY_NAME

getSORT_MACRODEFINITION_BY_ID

getSORT_MACRODEFINITION_BY_TITLE

getSORT_MACRODEFINITION_BY_IDANDTITLE

getSORT_SCRIPT_BY_ID

getSORT_SCRIPT_BY_TITLE

getSORT_SCRIPT_BY_IDANDTITLE

getAllReportSets

getAllReportSets

getAllReportSets

getAllReportSetsWithCategory

getAllReportSetsWithCategory

getAllReportSetsWithCategory

getAllReportSetsWithDefaultCategory

getAllReportSetsWithDefaultCategory

getAllReportSetsWithDefaultCategory

getAllRootReportSets

getAllRootReportSets

getAllRootReportSets

getAllRootReportSetsWithCategory

getAllRootReportSetsWithCategory

getAllRootReportSetsWithCategory

getAllRootReportSetsWithDefaultCategory

getAllRootReportSetsWithDefaultCategory

getAllRootReportSetsWithDefaultCategory

getAllReportSetsForHistoryItem

getAllReports

getAllReports

getAllReports

getAllReportsWithCategory

getAllReportsWithCategory

getAllReportsWithCategory

getAllReportsWithDefaultCategory

getAllReportsWithDefaultCategory

getAllReportsWithDefaultCategory

getAllRootReports

getAllRootReports

getAllRootReports

getAllRootReportsWithCategory

getAllRootReportsWithCategory

getAllRootReportsWithCategory

getAllRootReportsWithDefaultCategory

getAllRootReportsWithDefaultCategory

getAllRootReportsWithDefaultCategory

getAllReportsForHistoryItem

getAllReportConfigurations

getAllReportConfigurations

getAllReportConfigurations

getAllReportConfigurationsWithCategory

getAllReportConfigurationsWithCategory

getAllReportConfigurationsWithCategory

getAllReportConfigurationsWithDefaultCategory

getAllReportConfigurationsWithDefaultCategory

getAllReportConfigurationsWithDefaultCategory

getAllReportConfigurationsForHistoryItem

getAllSourceSets

getAllSourceSets

getAllSourceSets

getAllSourceSetsWithCategory

getAllSourceSetsWithCategory

getAllSourceSetsWithCategory

getAllSourceSetsWithDefaultCategory

getAllSourceSetsWithDefaultCategory

getAllSourceSetsWithDefaultCategory

getAllRootSourceSets

getAllRootSourceSets

getAllRootSourceSets

getAllRootSourceSetsWithCategory

getAllRootSourceSetsWithCategory

getAllRootSourceSetsWithCategory

getAllRootSourceSetsWithDefaultCategory

getAllRootSourceSetsWithDefaultCategory