com.arcway.cockpit.usecasemodule.docgen.provider.interfaces

Interface IUseCaseDataProvider

public interface IUseCaseDataProvider

The IUseCaseDataProvider allows to access objects of a COCKPIT project for document generation. The IUseCaseDataProvider can be referenced directly within a document template by its name usecaseDataProvider.

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends IActionStep>	getActionStepsForUniqueElement(java.lang.String uniqueElementUID) Returns all action steps that are linked to a unique element.
java.util.List<? extends IActionStep>	getAllActionStepsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry) Returns all action steps which have been modified the last time with the commit identified by the history item.
java.util.List<? extends IScenario>	getAllScenariosForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry) Returns all scenarios which have been modified the last time with the commit identified by the history item.
java.util.List<? extends IUseCaseCategory>	getAllUseCaseCategories() Returns all use case categories of the project.
java.util.List<? extends IUseCaseCategory>	getAllUseCaseCategories(java.lang.String sortingProperty) Returns all use case categories of the project.
java.util.List<? extends IUseCaseCategory>	getAllUseCaseCategoriesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry) Returns all use case categories which have been modified the last time with the commit identified by the history item.
java.util.List<? extends IUseCaseCategory>	getAllUseCaseCategoriesWithCategory(java.lang.String categoryID) Returns all use case categories of the project that belong to the specified category.
java.util.List<? extends IUseCaseCategory>	getAllUseCaseCategoriesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns all use case categories of the project that belong to the specified category.
java.util.List<? extends IUseCaseCategory>	getAllUseCaseCategoriesWithDefaultCategory() Returns all use case categories of the project that belong to the default category.
java.util.List<? extends IUseCaseCategory>	getAllUseCaseCategoriesWithDefaultCategory(java.lang.String sortingProperty) Returns all use case categories of the project that belong to the default category.
java.util.List<? extends IUseCase>	getAllUseCases() Returns all use cases of the project.
java.util.List<? extends IUseCase>	getAllUseCases(int sortingCriterion) Returns all use cases of the project.
java.util.List<? extends IUseCase>	getAllUseCases(java.lang.String sortingProperty) Returns all use cases of the project.
java.util.List<? extends IUseCase>	getAllUseCasesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry) Returns all use cases which have been modified the last time with the commit identified by the history item.
java.util.List<? extends IUseCase>	getAllUseCasesWithCategory(java.lang.String categoryID) Returns all use cases of the project that belong to the specified category.
java.util.List<? extends IUseCase>	getAllUseCasesWithCategory(java.lang.String categoryID, int sortingCriterion) Returns all use cases of the project that belong to the specified category.
java.util.List<? extends IUseCase>	getAllUseCasesWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns all use cases of the project that belong to the specified category.
java.util.List<? extends IUseCase>	getAllUseCasesWithDefaultCategory() Returns all use cases of the project that belong to the default category.
java.util.List<? extends IUseCase>	getAllUseCasesWithDefaultCategory(int sortingCriterion) Returns all use cases of the project that belong to the default category.
java.util.List<? extends IUseCase>	getAllUseCasesWithDefaultCategory(java.lang.String sortingProperty) Returns all use cases of the project that belong to the default category.
java.lang.String	getOutputFormat() Returns the output format for use cases preferred by the user.
int	getSORT_USECASE_BY_ID()
int	getSORT_USECASE_BY_INITIATOR()
int	getSORT_USECASE_BY_LEVEL()
int	getSORT_USECASE_BY_MAINACTOR()
int	getSORT_USECASE_BY_PRIORITY()
int	getSORT_USECASE_BY_STATE()
java.util.List<? extends IUseCase>	getUseCasesForUniqueElement(java.lang.String uniqueElementUID) Returns all use cases that are linked to a unique element.
java.util.List<? extends IUseCase>	getUseCasesForUniqueElement(java.lang.String uniqueElementUID, int sortingCriterion) Returns all use cases that are linked to a unique element.
java.util.List<? extends IUseCase>	getUseCasesForUniqueElement(java.lang.String uniqueElementUID, java.lang.String sortingProperty) Returns all use cases that are linked to a unique element.
boolean	hasActionStepsForUniqueElement(java.lang.String uniqueElementUID) Checks whether a unique element has linked action steps.
boolean	hasUseCasesForUniqueElement(java.lang.String uniqueElementUID) Checks whether a unique element has linked use cases.

Method Detail

getSORT_USECASE_BY_ID

int getSORT_USECASE_BY_ID()

Returns:

Constant for sorting use cases by ID

getSORT_USECASE_BY_INITIATOR

int getSORT_USECASE_BY_INITIATOR()

Returns:

Constant for sorting use cases by initiator

getSORT_USECASE_BY_MAINACTOR

int getSORT_USECASE_BY_MAINACTOR()

Returns:

Constant for sorting use cases by main actor

getSORT_USECASE_BY_LEVEL

int getSORT_USECASE_BY_LEVEL()

Returns:

Constant for sorting use cases by level

getSORT_USECASE_BY_PRIORITY

int getSORT_USECASE_BY_PRIORITY()

Returns:

Constant for sorting use cases by priority

getSORT_USECASE_BY_STATE

int getSORT_USECASE_BY_STATE()

Returns:

Constant for sorting use cases by state

getOutputFormat

java.lang.String getOutputFormat()

Returns the output format for use cases preferred by the user.

Returns:

the preferred output format

1. PreferenceManager.INLINE_EXTENDING_SCENARIOS for showing extending scenarios inline in the extended scenario
2. or PreferenceManager.SEPARATE_EXTENDING_SCENARIOS for showing the extending scenarios after the extended scenario

getAllUseCaseCategories

java.util.List<? extends IUseCaseCategory> getAllUseCaseCategories()

Returns all use case categories of the project.

The categories are sorted by name.

Returns:

array containing the use case categories (!= null)

getAllUseCaseCategoriesWithCategory

java.util.List<? extends IUseCaseCategory> getAllUseCaseCategoriesWithCategory(java.lang.String categoryID)

Returns all use case categories of the project that belong to the specified category.

The categories are sorted by name.

Parameters:

categoryID - the category ID

Returns:

array containing the use case categories (!= null)

getAllUseCaseCategoriesWithDefaultCategory

java.util.List<? extends IUseCaseCategory> getAllUseCaseCategoriesWithDefaultCategory()

Returns all use case categories of the project that belong to the default category.

The categories are sorted by name.

Returns:

array containing the use case categories (!= null)

getAllUseCaseCategories

java.util.List<? extends IUseCaseCategory> getAllUseCaseCategories(java.lang.String sortingProperty)

Returns all use case categories of the project.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting.

Returns:

array containing the use case categories (!= null)

getAllUseCaseCategoriesWithCategory

java.util.List<? extends IUseCaseCategory> getAllUseCaseCategoriesWithCategory(java.lang.String categoryID,
                                                                               java.lang.String sortingProperty)

Returns all use case categories 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:

array containing the use case categories (!= null)

getAllUseCaseCategoriesWithDefaultCategory

java.util.List<? extends IUseCaseCategory> getAllUseCaseCategoriesWithDefaultCategory(java.lang.String sortingProperty)

Returns all use case categories of the project that belong to the default category.

VTL-Codebeispiel:

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting.

Returns:

array containing the use case categories (!= null)

getAllUseCases

java.util.List<? extends IUseCase> getAllUseCases()

Returns all use cases of the project.

The use cases are sorted by id.

Returns:

array containing the use cases (!= null)

getAllUseCasesWithCategory

java.util.List<? extends IUseCase> getAllUseCasesWithCategory(java.lang.String categoryID)

Returns all use cases of the project that belong to the specified category.

The use cases are sorted by id.

Parameters:

categoryID - the category ID

Returns:

array containing the use cases (!= null)

getAllUseCasesWithDefaultCategory

java.util.List<? extends IUseCase> getAllUseCasesWithDefaultCategory()

Returns all use cases of the project that belong to the default category.

The use cases are sorted by id.

Returns:

array containing the use cases (!= null)

getAllUseCases

java.util.List<? extends IUseCase> getAllUseCases(int sortingCriterion)

Returns all use cases of the project.

VTL-Codebeispiel:
#foreach( $useCase in ${usecaseDataProvider.getUseCases($usecaseDataProvider.SORT_USECASE_BY_INITIATOR)} ) ... #end ##foreach

Parameters:

sortingCriterion - specifies the criterion for sorting. Use the integer constants in IUseCaseDataProvider.

Returns:

array containing the use cases (!= null)

getAllUseCasesWithCategory

java.util.List<? extends IUseCase> getAllUseCasesWithCategory(java.lang.String categoryID,
                                                              int sortingCriterion)

Returns all use cases of the project that belong to the specified category.

VTL-Codebeispiel:
#foreach( $useCase in ${usecaseDataProvider.getUseCases($usecaseDataProvider.SORT_USECASE_BY_INITIATOR)} ) ... #end ##foreach

Parameters:

categoryID - the category ID

sortingCriterion - specifies the criterion for sorting. Use the integer constants in IUseCaseDataProvider.

Returns:

array containing the use cases (!= null)

getAllUseCasesWithDefaultCategory

java.util.List<? extends IUseCase> getAllUseCasesWithDefaultCategory(int sortingCriterion)

Returns all use cases of the project that belong to the default category.

VTL-Codebeispiel:
#foreach( $useCase in ${usecaseDataProvider.getUseCases($usecaseDataProvider.SORT_USECASE_BY_INITIATOR)} ) ... #end ##foreach

Parameters:

sortingCriterion - specifies the criterion for sorting. Use the integer constants in IUseCaseDataProvider.

Returns:

array containing the use cases (!= null)

getAllUseCases

java.util.List<? extends IUseCase> getAllUseCases(java.lang.String sortingProperty)

Returns all use cases of the project.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting.

Returns:

array containing the use cases (!= null)

getAllUseCasesWithCategory

java.util.List<? extends IUseCase> getAllUseCasesWithCategory(java.lang.String categoryID,
                                                              java.lang.String sortingProperty)

Returns all use cases of the project that belong to the specified category.

Parameters:

categoryID - the categoryID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting.

Returns:

array containing the use cases (!= null)

getAllUseCasesWithDefaultCategory

java.util.List<? extends IUseCase> getAllUseCasesWithDefaultCategory(java.lang.String sortingProperty)

Returns all use cases 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:

array containing the use cases (!= null)

hasUseCasesForUniqueElement

boolean hasUseCasesForUniqueElement(java.lang.String uniqueElementUID)

Checks whether a unique element has linked use cases.

Parameters:

uniqueElementUID - UID of the unique element

Returns:

true, if use cases are linked to the unique element, false otherwise

hasActionStepsForUniqueElement

boolean hasActionStepsForUniqueElement(java.lang.String uniqueElementUID)

Checks whether a unique element has linked action steps.

Parameters:

uniqueElementUID - UID of the unique element.

Returns:

true, if action steps are linked to the unique element, false otherwise

getUseCasesForUniqueElement

java.util.List<? extends IUseCase> getUseCasesForUniqueElement(java.lang.String uniqueElementUID)

Returns all use cases that are linked to a unique element.

The use cases are sorted by ID.

Parameters:

uniqueElementUID - UID of the unique element

Returns:

array containing the use cases (!= null)

getUseCasesForUniqueElement

java.util.List<? extends IUseCase> getUseCasesForUniqueElement(java.lang.String uniqueElementUID,
                                                               int sortingCriterion)

Returns all use cases that are linked to a unique element.

Parameters:

uniqueElementUID - UID of the unique element

sortingCriterion - specifies the criterion for sorting. Use the integer constants in IUseCaseDataProvider.

Returns:

array containing the use cases (!= null)

getUseCasesForUniqueElement

java.util.List<? extends IUseCase> getUseCasesForUniqueElement(java.lang.String uniqueElementUID,
                                                               java.lang.String sortingProperty)

Returns all use cases that are linked to a unique element.

Parameters:

uniqueElementUID - UID of the unique element

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

array containing the use cases (!= null)

getActionStepsForUniqueElement

java.util.List<? extends IActionStep> getActionStepsForUniqueElement(java.lang.String uniqueElementUID)

Returns all action steps that are linked to a unique element.

Parameters:

uniqueElementUID - unique identifier of the unique element

Returns:

array containing the action steps (!= null)

getAllUseCaseCategoriesForHistoryItem

java.util.List<? extends IUseCaseCategory> getAllUseCaseCategoriesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry)

Returns all use case categories which have been modified the last time with the commit identified by the history item.

Each time, a user commits the project, a history entry is created.

Note: The current version of a use case category is only assigned to the history item for the commit of the last change of the use case category. This method does not allow to access old versions.

Preconditions:none
Postconditions:none

Parameters:

historyEntry - history item identifying the last change of the plans

Returns:

all use case categories modified the last time with the given history item

getAllUseCasesForHistoryItem

java.util.List<? extends IUseCase> getAllUseCasesForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry)

Returns all use cases which have been modified the last time with the commit identified by the history item.

Each time, a user commits the project, a history entry is created.

Note: The current version of a use case is only assigned to the history item for the commit of the last change of the use case. This method does not allow to access old versions.

Preconditions:none
Postconditions:none

Parameters:

historyEntry - history item identifying the last change of the plans

Returns:

all use cases modified the last time with the given history item

getAllScenariosForHistoryItem

java.util.List<? extends IScenario> getAllScenariosForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry)

Returns all scenarios which have been modified the last time with the commit identified by the history item.

Each time, a user commits the project, a history entry is created.

Note: The current version of a scenario is only assigned to the history item for the commit of the last change of the scenario. This method does not allow to access old versions.

Preconditions:none
Postconditions:none

Parameters:

historyEntry - history item identifying the last change of the plans

Returns:

all scenarios modified the last time with the given history item

getAllActionStepsForHistoryItem

java.util.List<? extends IActionStep> getAllActionStepsForHistoryItem(com.arcway.cockpit.docgen.provider.interfaces.IHistoryEntry historyEntry)

Returns all action steps which have been modified the last time with the commit identified by the history item.

Each time, a user commits the project, a history entry is created.

Note: The current version of an action step is only assigned to the history item for the commit of the last change of the action step. This method does not allow to access old versions.

Preconditions:none
Postconditions:none

Parameters:

historyEntry - history item identifying the last change of the plans

Returns:

all action steps modified the last time with the given history item