IRequirementDataProvider

All Superinterfaces:

com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementDataProvider_Legacy
```
public interface IRequirementDataProvider
extends com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementDataProvider_Legacy
```
The IRequirementDataProvider allows to access Requirements of a COCKPIT project for document generation. The IRequirementDataProvider can be referenced directly within a document template by its name requirementDataProvider.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IRequirementSet`	`findRequirementSet(java.lang.String path)` Searches for the requirement set item with the specified path.
`java.util.List<? extends IRequirementNote>`	`getAllRequirementNotes()` Returns all requirement note items of the project.
`java.util.List<? extends IRequirementNote>`	`getAllRequirementNotes(int sortingCriterion)` Returns all requirement note items of the project.
`java.util.List<? extends IRequirementNote>`	`getAllRequirementNotes(java.lang.String sortingProperty)` Returns all requirement note items of the project.
`java.util.List<? extends IRequirementNote>`	`getAllRequirementNotesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)` Returns all requirement note 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 IRequirementNote>`	`getAllRequirementNotesWithCategory(java.lang.String categoryID)` Returns all requirement note items of the project that belong to the specified category.
`java.util.List<? extends IRequirementNote>`	`getAllRequirementNotesWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all requirement note items of the project that belong to the specified category.
`java.util.List<? extends IRequirementNote>`	`getAllRequirementNotesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all requirement note items of the project that belong to the specified category.
`java.util.List<? extends IRequirementNote>`	`getAllRequirementNotesWithDefaultCategory()` Returns all requirement note items of the project that belong to the default category.
`java.util.List<? extends IRequirementNote>`	`getAllRequirementNotesWithDefaultCategory(int sortingCriterion)` Returns all requirement note items of the project that belong to the default category.
`java.util.List<? extends IRequirementNote>`	`getAllRequirementNotesWithDefaultCategory(java.lang.String sortingProperty)` Returns all requirement note items of the project that belong to the default category.
`java.util.List<? extends IRequirement>`	`getAllRequirements()` Returns all requirement items of the project.
`java.util.List<? extends IRequirement>`	`getAllRequirements(int sortingCriterion)` Returns all requirement items of the project.
`java.util.List<? extends IRequirement>`	`getAllRequirements(java.lang.String sortingProperty)` Returns all requirement items of the project.
`java.util.List<? extends IRequirementSet>`	`getAllRequirementSets()` Returns all requirement set items of the project.
`java.util.List<? extends IRequirementSet>`	`getAllRequirementSets(int sortingCriterion)` Returns all requirement set items of the project.
`java.util.List<? extends IRequirementSet>`	`getAllRequirementSets(java.lang.String sortingProperty)` Returns all requirement set items of the project.
`java.util.List<? extends IRequirementSet>`	`getAllRequirementSetsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)` Returns all requirement 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 IRequirementSet>`	`getAllRequirementSetsWithCategory(java.lang.String categoryID)` Returns all requirement set items of the project that belong to the specified category.
`java.util.List<? extends IRequirementSet>`	`getAllRequirementSetsWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all requirement set items of the project that belong to the specified category.
`java.util.List<? extends IRequirementSet>`	`getAllRequirementSetsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all requirement set items of the project that belong to the specified category.
`java.util.List<? extends IRequirementSet>`	`getAllRequirementSetsWithDefaultCategory()` Returns all requirement set items of the project that belong to the default category.
`java.util.List<? extends IRequirementSet>`	`getAllRequirementSetsWithDefaultCategory(int sortingCriterion)` Returns all requirement set items of the project that belong to the default category.
`java.util.List<? extends IRequirementSet>`	`getAllRequirementSetsWithDefaultCategory(java.lang.String sortingProperty)` Returns all requirement set items of the project that belong to the default category.
`java.util.List<? extends IRequirement>`	`getAllRequirementsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)` Returns all requirement 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 IRequirement>`	`getAllRequirementsForModelElement(java.lang.String modelElementUID)` Returns all requirement items of the project which are linked to the given model element.
`java.util.List<? extends IRequirement>`	`getAllRequirementsForModelElement(java.lang.String modelElementUID, int sortingCriterion)` Returns all requirement items of the project which are linked to the given model element.
`java.util.List<? extends IRequirement>`	`getAllRequirementsForModelElement(java.lang.String modelElementUID, java.lang.String sortingProperty)` Returns all requirement items of the project which are linked to the given model element.
`java.util.List<? extends IRequirement>`	`getAllRequirementsNotLinkedToAnyModelElement()` Returns all requirement items of the project which are not linked to any model element.
`java.util.List<? extends IRequirement>`	`getAllRequirementsNotLinkedToAnyModelElement(int sortingCriterion)` Returns all requirement items of the project which are not linked to any model element.
`java.util.List<? extends IRequirement>`	`getAllRequirementsNotLinkedToAnyModelElement(java.lang.String sortingProperty)` Returns all requirement items of the project which are not linked to any model element.
`java.util.List<? extends IRequirement>`	`getAllRequirementsWithCategory(java.lang.String categoryID)` Returns all requirement items of the project that belong to the specified category.
`java.util.List<? extends IRequirement>`	`getAllRequirementsWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all requirement items of the project that belong to the specified category.
`java.util.List<? extends IRequirement>`	`getAllRequirementsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all requirement items of the project that belong to the specified category.
`java.util.List<? extends IRequirement>`	`getAllRequirementsWithDefaultCategory()` Returns all requirement items of the project that belong to the default category.
`java.util.List<? extends IRequirement>`	`getAllRequirementsWithDefaultCategory(int sortingCriterion)` Returns all requirement items of the project that belong to the default category.
`java.util.List<? extends IRequirement>`	`getAllRequirementsWithDefaultCategory(java.lang.String sortingProperty)` Returns all requirement items of the project that belong to the default category.
`java.util.List<? extends IRequirement>`	`getAllRootRequirements()` Returns all root requirement items of the project.
`java.util.List<? extends IRequirement>`	`getAllRootRequirements(int sortingCriterion)` Returns all root requirement items of the project.
`java.util.List<? extends IRequirement>`	`getAllRootRequirements(java.lang.String sortingProperty)` Returns all root requirement items of the project.
`java.util.List<? extends IRequirementSet>`	`getAllRootRequirementSets()` Returns all root requirement set items of the project.
`java.util.List<? extends IRequirementSet>`	`getAllRootRequirementSets(int sortingCriterion)` Returns all root requirement set items of the project.
`java.util.List<? extends IRequirementSet>`	`getAllRootRequirementSets(java.lang.String sortingProperty)` Returns all root requirement set items of the project.
`java.util.List<? extends IRequirementSet>`	`getAllRootRequirementSetsWithCategory(java.lang.String categoryID)` Returns all root requirement set items of the project that belong to the specified category.
`java.util.List<? extends IRequirementSet>`	`getAllRootRequirementSetsWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all root requirement set items of the project that belong to the specified category.
`java.util.List<? extends IRequirementSet>`	`getAllRootRequirementSetsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all root requirement set items of the project that belong to the specified category.
`java.util.List<? extends IRequirementSet>`	`getAllRootRequirementSetsWithDefaultCategory()` Returns all root requirement set items of the project that belong to the default category.
`java.util.List<? extends IRequirementSet>`	`getAllRootRequirementSetsWithDefaultCategory(int sortingCriterion)` Returns all root requirement set items of the project that belong to the default category.
`java.util.List<? extends IRequirementSet>`	`getAllRootRequirementSetsWithDefaultCategory(java.lang.String sortingProperty)` Returns all root requirement set items of the project that belong to the default category.
`java.util.List<? extends IRequirement>`	`getAllRootRequirementsWithCategory(java.lang.String categoryID)` Returns all root requirement items of the project that belong to the specified category.
`java.util.List<? extends IRequirement>`	`getAllRootRequirementsWithCategory(java.lang.String categoryID, int sortingCriterion)` Returns all root requirement items of the project that belong to the specified category.
`java.util.List<? extends IRequirement>`	`getAllRootRequirementsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)` Returns all root requirement items of the project that belong to the specified category.
`java.util.List<? extends IRequirement>`	`getAllRootRequirementsWithDefaultCategory()` Returns all root requirement items of the project that belong to the default category.
`java.util.List<? extends IRequirement>`	`getAllRootRequirementsWithDefaultCategory(int sortingCriterion)` Returns all root requirement items of the project that belong to the default category.
`java.util.List<? extends IRequirement>`	`getAllRootRequirementsWithDefaultCategory(java.lang.String sortingProperty)` Returns all root requirement items of the project that belong to the default category.
`java.util.List<java.lang.String>`	`getKnownValuesForRequirementNoteNoteType()` Returns the known values for the note-type of requirement note items.
`java.util.List<java.lang.String>`	`getKnownValuesForRequirementPriority()` Returns the known values for the priority of requirement items.
`java.util.List<java.lang.String>`	`getKnownValuesForRequirementStatus()` Returns the known values for the status of requirement items.
`int`	`getSORT_REQUIREMENT_BY_ID()` Constant for sorting requirement items by id.
`int`	`getSORT_REQUIREMENT_BY_IDANDNAME()` Constant for sorting requirement items by id and name.
`int`	`getSORT_REQUIREMENT_BY_NAME()` Constant for sorting requirement items by name.
`int`	`getSORT_REQUIREMENT_BY_PRIORITY()` Constant for sorting requirement items by priority.
`int`	`getSORT_REQUIREMENT_BY_STATUS()` Constant for sorting requirement items by status.
`int`	`getSORT_REQUIREMENTNOTE_BY_NOTETYPE()` Constant for sorting requirement note items by note-type.
`int`	`getSORT_REQUIREMENTSET_BY_NAME()` Constant for sorting requirement set items by name.
`boolean`	`hasRequirementsForModelElement(java.lang.String modelElementUID)` Returns whether there are any requirement items linked to the specified model element.

Methods inherited from interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementDataProvider_Legacy
getAuthors, getInitiators, getNoteCategories, getRequirementCategories, getRequirementMilestones, getRequirementsForUniqueElement, getRequirementsForUniqueElement, getRequirementsForUniqueElement, getRequirementStates, getRootRequirementSets, getRootRequirementSets, getSORT_REQUIREMENT_BY_CATEGORY, getSORT_REQUIREMENT_BY_CLASSIFICATION, getSORT_REQUIREMENT_BY_INITIATOR, getSORT_REQUIREMENT_BY_STATE, getSORT_REQUIREMENT_BY_TITLE, getSORT_REQUIREMENT_BY_VERSION, getSORT_REQUIREMENTNOTE_BY_CATEGORY, getUnlinkedRequirements, getUnlinkedRequirements, getUnlinkedRequirements, hasRequirementsForUniqueElement

- Method Detail
  - getSORT_REQUIREMENTSET_BY_NAME
```
int getSORT_REQUIREMENTSET_BY_NAME()
```
    Constant for sorting requirement set items by name.
    
    Specified by:
    
    getSORT_REQUIREMENTSET_BY_NAME in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementDataProvider_Legacy
    
    Returns:
    
    constant for sorting requirement set items by name
  - getSORT_REQUIREMENT_BY_ID
```
int getSORT_REQUIREMENT_BY_ID()
```
    Constant for sorting requirement items by id.
    
    Specified by:
    
    getSORT_REQUIREMENT_BY_ID in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementDataProvider_Legacy
    
    Returns:
    
    constant for sorting requirement items by id
  - getSORT_REQUIREMENT_BY_NAME
```
int getSORT_REQUIREMENT_BY_NAME()
```
    Constant for sorting requirement items by name.
    
    Returns:
    
    constant for sorting requirement items by name
  - getSORT_REQUIREMENT_BY_STATUS
```
int getSORT_REQUIREMENT_BY_STATUS()
```
    Constant for sorting requirement items by status.
    
    Returns:
    
    constant for sorting requirement items by status
  - getSORT_REQUIREMENT_BY_PRIORITY
```
int getSORT_REQUIREMENT_BY_PRIORITY()
```
    Constant for sorting requirement items by priority.
    
    Specified by:
    
    getSORT_REQUIREMENT_BY_PRIORITY in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementDataProvider_Legacy
    
    Returns:
    
    constant for sorting requirement items by priority
  - getSORT_REQUIREMENT_BY_IDANDNAME
```
int getSORT_REQUIREMENT_BY_IDANDNAME()
```
    Constant for sorting requirement items by id and name.
    
    Returns:
    
    constant for sorting requirement items by id and name
  - getSORT_REQUIREMENTNOTE_BY_NOTETYPE
```
int getSORT_REQUIREMENTNOTE_BY_NOTETYPE()
```
    Constant for sorting requirement note items by note-type.
    
    Returns:
    
    constant for sorting requirement note items by note-type
  - getAllRequirementSets
```
java.util.List<? extends IRequirementSet> getAllRequirementSets()
```
    Returns all requirement set items of the project.
    
    The requirement set items are sorted by name.
    
    Specified by:
    
    getAllRequirementSets in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementDataProvider_Legacy
    
    Returns:
    
    list of IRequirementSet objects (!= null)
  - getAllRequirementSets
```
java.util.List<? extends IRequirementSet> getAllRequirementSets(int sortingCriterion)
```
    Returns all requirement set items of the project.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IRequirementSet objects (!= null)
  - getAllRequirementSets
```
java.util.List<? extends IRequirementSet> getAllRequirementSets(java.lang.String sortingProperty)
```
    Returns all requirement set items of the project.
    
    Specified by:
    
    getAllRequirementSets in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementDataProvider_Legacy
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IRequirementSet objects (!= null)
  - getAllRequirementSetsWithCategory
```
java.util.List<? extends IRequirementSet> getAllRequirementSetsWithCategory(java.lang.String categoryID)
```
    Returns all requirement set items of the project that belong to the specified category.
    
    The requirement set items are sorted by name.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of IRequirementSet objects (!= null)
  - getAllRequirementSetsWithCategory
```
java.util.List<? extends IRequirementSet> getAllRequirementSetsWithCategory(java.lang.String categoryID,
                                                                            int sortingCriterion)
```
    Returns all requirement 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 IRequirementSet objects (!= null)
  - getAllRequirementSetsWithCategory
```
java.util.List<? extends IRequirementSet> getAllRequirementSetsWithCategory(java.lang.String categoryID,
                                                                            java.lang.String sortingProperty)
```
    Returns all requirement 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 IRequirementSet objects (!= null)
  - getAllRequirementSetsWithDefaultCategory
```
java.util.List<? extends IRequirementSet> getAllRequirementSetsWithDefaultCategory()
```
    Returns all requirement set items of the project that belong to the default category.
    
    The requirement set items are sorted by name.
    
    Returns:
    
    list of IRequirementSet objects (!= null)
  - getAllRequirementSetsWithDefaultCategory
```
java.util.List<? extends IRequirementSet> getAllRequirementSetsWithDefaultCategory(int sortingCriterion)
```
    Returns all requirement 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 IRequirementSet objects (!= null)
  - getAllRequirementSetsWithDefaultCategory
```
java.util.List<? extends IRequirementSet> getAllRequirementSetsWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all requirement 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 IRequirementSet objects (!= null)
  - getAllRootRequirementSets
```
java.util.List<? extends IRequirementSet> getAllRootRequirementSets()
```
    Returns all root requirement set items of the project.
    
    The requirement set items are returned in their natural order.
    
    Returns:
    
    list of IRequirementSet objects (!= null)
  - getAllRootRequirementSets
```
java.util.List<? extends IRequirementSet> getAllRootRequirementSets(int sortingCriterion)
```
    Returns all root requirement set items of the project.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IRequirementSet objects (!= null)
  - getAllRootRequirementSets
```
java.util.List<? extends IRequirementSet> getAllRootRequirementSets(java.lang.String sortingProperty)
```
    Returns all root requirement set items of the project.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IRequirementSet objects (!= null)
  - getAllRootRequirementSetsWithCategory
```
java.util.List<? extends IRequirementSet> getAllRootRequirementSetsWithCategory(java.lang.String categoryID)
```
    Returns all root requirement set items of the project that belong to the specified category.
    
    The requirement set items are returned in their natural order.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of IRequirementSet objects (!= null)
  - getAllRootRequirementSetsWithCategory
```
java.util.List<? extends IRequirementSet> getAllRootRequirementSetsWithCategory(java.lang.String categoryID,
                                                                                int sortingCriterion)
```
    Returns all root requirement 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 IRequirementSet objects (!= null)
  - getAllRootRequirementSetsWithCategory
```
java.util.List<? extends IRequirementSet> getAllRootRequirementSetsWithCategory(java.lang.String categoryID,
                                                                                java.lang.String sortingProperty)
```
    Returns all root requirement 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 IRequirementSet objects (!= null)
  - getAllRootRequirementSetsWithDefaultCategory
```
java.util.List<? extends IRequirementSet> getAllRootRequirementSetsWithDefaultCategory()
```
    Returns all root requirement set items of the project that belong to the default category.
    
    The requirement set items are returned in their natural order.
    
    Returns:
    
    list of IRequirementSet objects (!= null)
  - getAllRootRequirementSetsWithDefaultCategory
```
java.util.List<? extends IRequirementSet> getAllRootRequirementSetsWithDefaultCategory(int sortingCriterion)
```
    Returns all root requirement 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 IRequirementSet objects (!= null)
  - getAllRootRequirementSetsWithDefaultCategory
```
java.util.List<? extends IRequirementSet> getAllRootRequirementSetsWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all root requirement 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 IRequirementSet objects (!= null)
  - getAllRequirementSetsForHistoryItem
```
java.util.List<? extends IRequirementSet> getAllRequirementSetsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
```
    Returns all requirement 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 requirement set is only assigned to the history item for the commit of the last change of the requirement set. This method does not allow to access old versions.
    
    Parameters:
    
    historyItem - history item identifying the last change of the requirement set items
    
    Returns:
    
    all requirement set items modified the last time with the specified commit
  - getAllRequirements
```
java.util.List<? extends IRequirement> getAllRequirements()
```
    Returns all requirement items of the project.
    
    The requirement items are sorted by id and name.
    
    Specified by:
    
    getAllRequirements in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementDataProvider_Legacy
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRequirements
```
java.util.List<? extends IRequirement> getAllRequirements(int sortingCriterion)
```
    Returns all requirement items of the project.
    
    Specified by:
    
    getAllRequirements in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementDataProvider_Legacy
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRequirements
```
java.util.List<? extends IRequirement> getAllRequirements(java.lang.String sortingProperty)
```
    Returns all requirement items of the project.
    
    Specified by:
    
    getAllRequirements in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementDataProvider_Legacy
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRequirementsWithCategory
```
java.util.List<? extends IRequirement> getAllRequirementsWithCategory(java.lang.String categoryID)
```
    Returns all requirement items of the project that belong to the specified category.
    
    The requirement items are sorted by id and name.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRequirementsWithCategory
```
java.util.List<? extends IRequirement> getAllRequirementsWithCategory(java.lang.String categoryID,
                                                                      int sortingCriterion)
```
    Returns all requirement 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 IRequirement objects (!= null)
  - getAllRequirementsWithCategory
```
java.util.List<? extends IRequirement> getAllRequirementsWithCategory(java.lang.String categoryID,
                                                                      java.lang.String sortingProperty)
```
    Returns all requirement 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 IRequirement objects (!= null)
  - getAllRequirementsWithDefaultCategory
```
java.util.List<? extends IRequirement> getAllRequirementsWithDefaultCategory()
```
    Returns all requirement items of the project that belong to the default category.
    
    The requirement items are sorted by id and name.
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRequirementsWithDefaultCategory
```
java.util.List<? extends IRequirement> getAllRequirementsWithDefaultCategory(int sortingCriterion)
```
    Returns all requirement 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 IRequirement objects (!= null)
  - getAllRequirementsWithDefaultCategory
```
java.util.List<? extends IRequirement> getAllRequirementsWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all requirement 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 IRequirement objects (!= null)
  - getAllRootRequirements
```
java.util.List<? extends IRequirement> getAllRootRequirements()
```
    Returns all root requirement items of the project.
    
    The requirement items are returned in their natural order.
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRootRequirements
```
java.util.List<? extends IRequirement> getAllRootRequirements(int sortingCriterion)
```
    Returns all root requirement items of the project.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRootRequirements
```
java.util.List<? extends IRequirement> getAllRootRequirements(java.lang.String sortingProperty)
```
    Returns all root requirement items of the project.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRootRequirementsWithCategory
```
java.util.List<? extends IRequirement> getAllRootRequirementsWithCategory(java.lang.String categoryID)
```
    Returns all root requirement items of the project that belong to the specified category.
    
    The requirement items are returned in their natural order.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRootRequirementsWithCategory
```
java.util.List<? extends IRequirement> getAllRootRequirementsWithCategory(java.lang.String categoryID,
                                                                          int sortingCriterion)
```
    Returns all root requirement 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 IRequirement objects (!= null)
  - getAllRootRequirementsWithCategory
```
java.util.List<? extends IRequirement> getAllRootRequirementsWithCategory(java.lang.String categoryID,
                                                                          java.lang.String sortingProperty)
```
    Returns all root requirement 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 IRequirement objects (!= null)
  - getAllRootRequirementsWithDefaultCategory
```
java.util.List<? extends IRequirement> getAllRootRequirementsWithDefaultCategory()
```
    Returns all root requirement items of the project that belong to the default category.
    
    The requirement items are returned in their natural order.
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRootRequirementsWithDefaultCategory
```
java.util.List<? extends IRequirement> getAllRootRequirementsWithDefaultCategory(int sortingCriterion)
```
    Returns all root requirement 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 IRequirement objects (!= null)
  - getAllRootRequirementsWithDefaultCategory
```
java.util.List<? extends IRequirement> getAllRootRequirementsWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all root requirement 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 IRequirement objects (!= null)
  - hasRequirementsForModelElement
```
boolean hasRequirementsForModelElement(java.lang.String modelElementUID)
```
    Returns whether there are any requirement items linked to the specified model element. The model element is indentified by its unique identifier.
    
    Parameters:
    
    modelElementUID - unique identifier of the model element
    
    Returns:
    
    whether there are any requirement items linked to the specified model element
  - getAllRequirementsForModelElement
```
java.util.List<? extends IRequirement> getAllRequirementsForModelElement(java.lang.String modelElementUID)
```
    Returns all requirement items of the project which are linked to the given model element.
    
    The requirement items are sorted by id and name.
    
    Parameters:
    
    modelElementUID - the uid of the model element
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRequirementsForModelElement
```
java.util.List<? extends IRequirement> getAllRequirementsForModelElement(java.lang.String modelElementUID,
                                                                         int sortingCriterion)
```
    Returns all requirement items of the project which are linked to the given model element.
    
    Parameters:
    
    modelElementUID - the uid of the model element
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRequirementsForModelElement
```
java.util.List<? extends IRequirement> getAllRequirementsForModelElement(java.lang.String modelElementUID,
                                                                         java.lang.String sortingProperty)
```
    Returns all requirement items of the project which are linked to the given model element.
    
    Parameters:
    
    modelElementUID - the uid of the model element
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRequirementsNotLinkedToAnyModelElement
```
java.util.List<? extends IRequirement> getAllRequirementsNotLinkedToAnyModelElement()
```
    Returns all requirement items of the project which are not linked to any model element.
    
    The requirement items are sorted by id and name.
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRequirementsNotLinkedToAnyModelElement
```
java.util.List<? extends IRequirement> getAllRequirementsNotLinkedToAnyModelElement(int sortingCriterion)
```
    Returns all requirement items of the project which are not linked to any model element.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRequirementsNotLinkedToAnyModelElement
```
java.util.List<? extends IRequirement> getAllRequirementsNotLinkedToAnyModelElement(java.lang.String sortingProperty)
```
    Returns all requirement items of the project which are not linked to any model element.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IRequirement objects (!= null)
  - getAllRequirementsForHistoryItem
```
java.util.List<? extends IRequirement> getAllRequirementsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
```
    Returns all requirement 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 requirement is only assigned to the history item for the commit of the last change of the requirement. This method does not allow to access old versions.
    
    Parameters:
    
    historyItem - history item identifying the last change of the requirement items
    
    Returns:
    
    all requirement items modified the last time with the specified commit
  - getAllRequirementNotes
```
java.util.List<? extends IRequirementNote> getAllRequirementNotes()
```
    Returns all requirement note items of the project.
    
    The requirement note items are sorted by text.
    
    Returns:
    
    list of IRequirementNote objects (!= null)
  - getAllRequirementNotes
```
java.util.List<? extends IRequirementNote> getAllRequirementNotes(int sortingCriterion)
```
    Returns all requirement note items of the project.
    
    Parameters:
    
    sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)
    
    Returns:
    
    list of IRequirementNote objects (!= null)
  - getAllRequirementNotes
```
java.util.List<? extends IRequirementNote> getAllRequirementNotes(java.lang.String sortingProperty)
```
    Returns all requirement note items of the project.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting
    
    Returns:
    
    list of IRequirementNote objects (!= null)
  - getAllRequirementNotesWithCategory
```
java.util.List<? extends IRequirementNote> getAllRequirementNotesWithCategory(java.lang.String categoryID)
```
    Returns all requirement note items of the project that belong to the specified category.
    
    The requirement note items are sorted by text.
    
    Parameters:
    
    categoryID - the category ID
    
    Returns:
    
    list of IRequirementNote objects (!= null)
  - getAllRequirementNotesWithCategory
```
java.util.List<? extends IRequirementNote> getAllRequirementNotesWithCategory(java.lang.String categoryID,
                                                                              int sortingCriterion)
```
    Returns all requirement note 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 IRequirementNote objects (!= null)
  - getAllRequirementNotesWithCategory
```
java.util.List<? extends IRequirementNote> getAllRequirementNotesWithCategory(java.lang.String categoryID,
                                                                              java.lang.String sortingProperty)
```
    Returns all requirement note 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 IRequirementNote objects (!= null)
  - getAllRequirementNotesWithDefaultCategory
```
java.util.List<? extends IRequirementNote> getAllRequirementNotesWithDefaultCategory()
```
    Returns all requirement note items of the project that belong to the default category.
    
    The requirement note items are sorted by text.
    
    Returns:
    
    list of IRequirementNote objects (!= null)
  - getAllRequirementNotesWithDefaultCategory
```
java.util.List<? extends IRequirementNote> getAllRequirementNotesWithDefaultCategory(int sortingCriterion)
```
    Returns all requirement note 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 IRequirementNote objects (!= null)
  - getAllRequirementNotesWithDefaultCategory
```
java.util.List<? extends IRequirementNote> getAllRequirementNotesWithDefaultCategory(java.lang.String sortingProperty)
```
    Returns all requirement note 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 IRequirementNote objects (!= null)
  - getAllRequirementNotesForHistoryItem
```
java.util.List<? extends IRequirementNote> getAllRequirementNotesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyItem)
```
    Returns all requirement note 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 requirement note is only assigned to the history item for the commit of the last change of the requirement note. This method does not allow to access old versions.
    
    Parameters:
    
    historyItem - history item identifying the last change of the requirement note items
    
    Returns:
    
    all requirement note items modified the last time with the specified commit
  - findRequirementSet
```
IRequirementSet findRequirementSet(java.lang.String path)
```
    Searches for the requirement set item with the specified path. A path is a "/" separated list of requirement set names (e.g. "foo1/foo1.2" means "foo1.2" as child requirement set of "foo1").
    
    If a requirement set name contains a slash ("/"), than the slash must be replaced by a double slash ("//"). Attention: Slashes at the beginning of a requirement set name are not supported, because "foo1///foo2" would be interpreted as: "foo2" as a child of "foo1/".
    
    Attention: Only requirement set items which pass the filter must be contained in the path.
    
    Specified by:
    
    findRequirementSet in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementDataProvider_Legacy
    
    Parameters:
    
    path - the path
    
    Returns:
    
    the requirement set specified by the path if found, null otherwise
  - getKnownValuesForRequirementStatus
```
java.util.List<java.lang.String> getKnownValuesForRequirementStatus()
```
    Returns the known values for the status of requirement items.
    
    Returns:
    
    the known values as List of String
  - getKnownValuesForRequirementPriority
```
java.util.List<java.lang.String> getKnownValuesForRequirementPriority()
```
    Returns the known values for the priority of requirement items.
    
    Returns:
    
    the known values as List of String
  - getKnownValuesForRequirementNoteNoteType
```
java.util.List<java.lang.String> getKnownValuesForRequirementNoteNoteType()
```
    Returns the known values for the note-type of requirement note items.
    
    Returns:
    
    the known values as List of String

Interface IRequirementDataProvider

Method Summary

Methods inherited from interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementDataProvider_Legacy

Method Detail

getSORT_REQUIREMENTSET_BY_NAME

getSORT_REQUIREMENT_BY_ID

getSORT_REQUIREMENT_BY_NAME

getSORT_REQUIREMENT_BY_STATUS

getSORT_REQUIREMENT_BY_PRIORITY

getSORT_REQUIREMENT_BY_IDANDNAME

getSORT_REQUIREMENTNOTE_BY_NOTETYPE

getAllRequirementSets

getAllRequirementSets

getAllRequirementSets

getAllRequirementSetsWithCategory

getAllRequirementSetsWithCategory

getAllRequirementSetsWithCategory

getAllRequirementSetsWithDefaultCategory

getAllRequirementSetsWithDefaultCategory

getAllRequirementSetsWithDefaultCategory

getAllRootRequirementSets

getAllRootRequirementSets

getAllRootRequirementSets

getAllRootRequirementSetsWithCategory

getAllRootRequirementSetsWithCategory

getAllRootRequirementSetsWithCategory

getAllRootRequirementSetsWithDefaultCategory

getAllRootRequirementSetsWithDefaultCategory

getAllRootRequirementSetsWithDefaultCategory

getAllRequirementSetsForHistoryItem

getAllRequirements

getAllRequirements

getAllRequirements

getAllRequirementsWithCategory

getAllRequirementsWithCategory

getAllRequirementsWithCategory

getAllRequirementsWithDefaultCategory

getAllRequirementsWithDefaultCategory

getAllRequirementsWithDefaultCategory

getAllRootRequirements

getAllRootRequirements

getAllRootRequirements

getAllRootRequirementsWithCategory

getAllRootRequirementsWithCategory

getAllRootRequirementsWithCategory

getAllRootRequirementsWithDefaultCategory

getAllRootRequirementsWithDefaultCategory

getAllRootRequirementsWithDefaultCategory

hasRequirementsForModelElement

getAllRequirementsForModelElement

getAllRequirementsForModelElement

getAllRequirementsForModelElement

getAllRequirementsNotLinkedToAnyModelElement

getAllRequirementsNotLinkedToAnyModelElement

getAllRequirementsNotLinkedToAnyModelElement

getAllRequirementsForHistoryItem

getAllRequirementNotes

getAllRequirementNotes

getAllRequirementNotes

getAllRequirementNotesWithCategory

getAllRequirementNotesWithCategory

getAllRequirementNotesWithCategory

getAllRequirementNotesWithDefaultCategory

getAllRequirementNotesWithDefaultCategory

getAllRequirementNotesWithDefaultCategory

getAllRequirementNotesForHistoryItem

findRequirementSet

getKnownValuesForRequirementStatus

getKnownValuesForRequirementPriority

getKnownValuesForRequirementNoteNoteType