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

Interface IActionStepEnd

public interface IActionStepEnd

The IActionStepEnd object is a "virtual" action step that succeeds the last "real" action step of a scenario from the COCKPIT use case module. Using this object you can get references to extension scenarios and extension use cases ending after the last "real" action step of a scenario.

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends IScenario>	getEndingExtensionScenarios() Returns the extension scenarios ending at the action step.
java.util.List<? extends IScenario>	getEndingExtensionScenarios(java.lang.String sortingProperty) Returns the extension scenarios ending at the action step.
java.util.List<? extends IUseCase>	getEndingExtensionUseCases() Returns the extension use cases ending at the action step.
java.util.List<? extends IUseCase>	getEndingExtensionUseCases(int sortingCriterion) Returns the extension use cases ending at the action step.
java.util.List<? extends IUseCase>	getEndingExtensionUseCases(java.lang.String sortingProperty) Returns the extension use cases ending at the action step.
IScenario	getScenario() Returns the scenario the action step belongs to.
java.util.List<? extends IScenario>	getStartingExtensionScenarios() Returns the extension scenarios starting at the action step.
java.util.List<? extends IScenario>	getStartingExtensionScenarios(java.lang.String sortingProperty) Returns the extension scenarios starting at the action step.
java.util.List<? extends IUseCase>	getStartingExtensionUseCases() Returns the extension use cases starting at the action step.
java.util.List<? extends IUseCase>	getStartingExtensionUseCases(int sortingCriterion) Returns the extension use cases starting at the action step
java.util.List<IUseCase>	getStartingExtensionUseCases(java.lang.String sortingProperty) Returns the extension use cases starting at the action step.
boolean	isEndOfExtensionScenarios() Checks whether the action step is the end point of extension scenarios.
boolean	isEndOfExtensionUseCases() Checks whether the action step is the end point of extension use cases.
boolean	isStartOfExtensionScenarios() Checks whether the action step is the starting point of extension scenarios.
boolean	isStartOfExtensionUseCases() Checks whether the action step is the starting point of extension use cases.

Method Detail

getScenario

IScenario getScenario()

Returns the scenario the action step belongs to.

Returns:

the scenario

isStartOfExtensionScenarios

boolean isStartOfExtensionScenarios()

Checks whether the action step is the starting point of extension scenarios.

Returns:

true, if extension scenarios exist, false otherwise

getStartingExtensionScenarios

java.util.List<? extends IScenario> getStartingExtensionScenarios()

Returns the extension scenarios starting at the action step.

The scenarios are sorted by id.

Returns:

array containing the extension scenarios

getStartingExtensionScenarios

java.util.List<? extends IScenario> getStartingExtensionScenarios(java.lang.String sortingProperty)

Returns the extension scenarios starting at the action step.

Parameters:

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

Returns:

array containing the extension scenarios

isStartOfExtensionUseCases

boolean isStartOfExtensionUseCases()

Checks whether the action step is the starting point of extension use cases.

Returns:

true, if extension use cases exist, false otherwise

getStartingExtensionUseCases

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

Returns the extension use cases starting at the action step.

The use cases are sorted by id.

Returns:

array containing the extension use cases

getStartingExtensionUseCases

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

Returns the extension use cases starting at the action step

Parameters:

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

Returns:

array containing the extension use cases

getStartingExtensionUseCases

java.util.List<IUseCase> getStartingExtensionUseCases(java.lang.String sortingProperty)

Returns the extension use cases starting at the action step.

Parameters:

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

Returns:

array containing the extension use cases

isEndOfExtensionScenarios

boolean isEndOfExtensionScenarios()

Checks whether the action step is the end point of extension scenarios.

Returns:

true, if extension scenarios exist, false otherwise

getEndingExtensionScenarios

java.util.List<? extends IScenario> getEndingExtensionScenarios()

Returns the extension scenarios ending at the action step.

The scenarios are sorted by id.

Returns:

array containing the extension scenarios

getEndingExtensionScenarios

java.util.List<? extends IScenario> getEndingExtensionScenarios(java.lang.String sortingProperty)

Returns the extension scenarios ending at the action step.

Parameters:

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

Returns:

array containing the extension scenarios

isEndOfExtensionUseCases

boolean isEndOfExtensionUseCases()

Checks whether the action step is the end point of extension use cases.

Returns:

true, if extension use cases exist, false otherwise

getEndingExtensionUseCases

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

Returns the extension use cases ending at the action step.

The use cases are sorted by id.

Returns:

array containing the extension use cases

getEndingExtensionUseCases

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

Returns the extension use cases ending at the action step.

Parameters:

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

Returns:

array containing the extension use cases

getEndingExtensionUseCases

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

Returns the extension use cases ending at the action step.

Parameters:

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

Returns:

array containing the extension use cases