IScenario

All Superinterfaces:

com.arcway.cockpit.docgen.provider.interfaces.ICockpitData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess, com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData
```
public interface IScenario
extends com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
```
The IScenario object allows to read attribute values of a scenario from the COCKPIT use case module. Starting with this object, you can get references to the action steps of the scenario.
Item type constant: "ucm.scenario"

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`IActionStepEnd`	`getActionStepEnd()` Returns a "virtual" action step which succeeds the last action step.
`java.util.List<? extends IActionStep>`	`getActionSteps()` Returns all action steps of the scenario.
`IScenario`	`getExtendedScenario()` Returns the scenario which is extended by this scenario.
`java.lang.String`	`getExtendingScenarioEndType()` Returns the end type of the scenario.
`java.util.List<? extends IScenario>`	`getExtensionScenarios()` Returns all immediate extension scenarios of the scenario.
`java.util.List<? extends IScenario>`	`getExtensionScenarios(java.lang.String sortingProperty)` Returns all immediate extension scenarios of the scenario.
`java.util.List<? extends IUseCase>`	`getExtensionUseCases()` Returns all immediate extension use cases of the scenario.
`java.util.List<? extends IUseCase>`	`getExtensionUseCases(int sortingCriterion)` Returns all immediate extension use cases of the scenario.
`java.util.List<? extends IUseCase>`	`getExtensionUseCases(java.lang.String sortingProperty)` Returns all immediate extension use cases of the scenario.
`java.util.List<java.lang.String>`	`getFinalStateOnFailure()` Returns the description of the final state of the scenario in case of failure.
`java.util.List<java.lang.String>`	`getFinalStateOnSuccess()` Returns the description of the final state of the scenario in case of successful completion.
`java.util.List<java.lang.String>`	`getGoal()` Returns the goal of the scenario.
`java.lang.String`	`getId()` Returns the id of the scenario.
`java.util.List<java.lang.String>`	`getInitialSituation()` Returns the description of the initial situation of the use case.
`java.util.List<java.lang.String>`	`getPostconditionOnFailure()` Deprecated. replaced by getFinalStateOnFailure()
`java.util.List<java.lang.String>`	`getPostconditionOnSuccess()` Deprecated. replaced by getFinalStateOnSuccess()
`java.util.List<java.lang.String>`	`getPrecondition()` Deprecated. replaced by getInitialSituation()
`java.util.List<java.lang.String>`	`getTrigger()` Deprecated. replaced by getTriggeringEvent()
`java.util.List<java.lang.String>`	`getTriggeringEvent()` Returns the description of the triggering event of the use case.
`java.lang.String`	`getUniqueIdentifier()` Returns a unique identifier that uniquely identifies this object within its project.
`IUseCase`	`getUseCase()` Returns the use case which this scenario is the main scenario or an extension scenario (immediate or transitive) of.
`boolean`	`hasActionSteps()` Checks whether action steps are defined for the scenario.
`boolean`	`hasExtensionScenarios()` Checks whether the scenario has extension scenarios.
`boolean`	`hasExtensionUseCases()` Checks whether the scenario has extension use cases.
`boolean`	`isExtensionScenario()` Checks whether the scenario is an extension scenario (as opposed to a main scenario).
`com.arcway.cockpit.docgen.provider.interfaces.IRecord`	`toRecord()` Converts this generic module data into a record.

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
getCategoryID, getCategoryLabel, getDateTimeProperty_MilliSecondsSince_01_01_1970, getFileProperty, getFileProperty, getFilePropertyAsBase64StringList, getFilePropertyAsFileName, getFilePropertyAsFileName, getFilePropertyAsRawStringList, getFilePropertyAsStringList, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringList, hasCustomPropertyValues, hasDefaultCategory, hasPropertyValue, readImageInfoOfFileProperty

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
getCommitVersion, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

- Method Detail
  - getUniqueIdentifier
```
java.lang.String getUniqueIdentifier()
```
    Returns a unique identifier that uniquely identifies this object within its project.
    
    Specified by:
    
    getUniqueIdentifier in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
    
    Returns:
    
    unique identifier
  - getId
```
java.lang.String getId()
```
    Returns the id of the scenario.
    
    Returns:
    
    the id
  - getGoal
```
java.util.List<java.lang.String> getGoal()
```
    Returns the goal of the scenario. If the goal consists of multiple paragraphs (ENTER) each paragraph is represented by an element in the String array.
    
    Returns:
    
    the goal as array of paragraphs
  - getPrecondition
```
@Deprecated
java.util.List<java.lang.String> getPrecondition()
```
    Deprecated. replaced by getInitialSituation()
    
    Returns the precondition of the use case. If the precondition consists of multiple paragraphs (ENTER) each paragraph is represented by an element in the String array.
    
    Returns:
    
    the precondition as array of paragraphs
  - getInitialSituation
```
java.util.List<java.lang.String> getInitialSituation()
```
    Returns the description of the initial situation of the use case. If the description consists of multiple paragraphs (ENTER) each paragraph is represented by an element in the String array.
    
    Returns:
    
    the description of the initial situation as array of paragraphs
  - getPostconditionOnSuccess
```
@Deprecated
java.util.List<java.lang.String> getPostconditionOnSuccess()
```
    Deprecated. replaced by getFinalStateOnSuccess()
    
    Returns the postcondition of the scenario in case of successful completion. If the postcondition consists of multiple paragraphs (ENTER) each paragraph is represented by an element in the String array.
    
    Returns:
    
    the postcondition on success as array of paragraphs
  - getFinalStateOnSuccess
```
java.util.List<java.lang.String> getFinalStateOnSuccess()
```
    Returns the description of the final state of the scenario in case of successful completion. If the description consists of multiple paragraphs (ENTER) each paragraph is represented by an element in the String array.
    
    Returns:
    
    the description of the final state on success as array of paragraphs
  - getPostconditionOnFailure
```
@Deprecated
java.util.List<java.lang.String> getPostconditionOnFailure()
```
    Deprecated. replaced by getFinalStateOnFailure()
    
    Returns the postcondition of the scenario in case of failure. If the postcondition consists of multiple paragraphs (ENTER) each paragraph is represented by an element in the String array.
    
    Returns:
    
    the postcondition on failure as array of paragraphs
  - getFinalStateOnFailure
```
java.util.List<java.lang.String> getFinalStateOnFailure()
```
    Returns the description of the final state of the scenario in case of failure. If the description consists of multiple paragraphs (ENTER) each paragraph is represented by an element in the String array.
    
    Returns:
    
    the description of the final state on failure as array of paragraphs
  - getTrigger
```
@Deprecated
java.util.List<java.lang.String> getTrigger()
```
    Deprecated. replaced by getTriggeringEvent()
    
    Returns the trigger of the use case. If the trigger consists of multiple paragraphs (ENTER) each paragraph is represented by an element in the String array.
    
    Returns:
    
    the trigger as array of paragraphs
  - getTriggeringEvent
```
java.util.List<java.lang.String> getTriggeringEvent()
```
    Returns the description of the triggering event of the use case. If the description consists of multiple paragraphs (ENTER) each paragraph is represented by an element in the String array.
    
    Returns:
    
    the description of the triggering event as array of paragraphs
  - getUseCase
```
IUseCase getUseCase()
```
    Returns the use case which this scenario is the main scenario or an extension scenario (immediate or transitive) of.
    By "transitive" the following is expressed: If the given scenario is an extension scenario, than the algorithm goes upward iteratively to the extended scenario until a main scenario is found. Then the use case which this is the main scenario of is returned.
    
    Returns:
    
    the use case
  - getActionStepEnd
```
IActionStepEnd getActionStepEnd()
```
    Returns a "virtual" action step which succeeds the last action step.
    This dummy action step can be used to retrieve the extensions, which start after the last "real" action step.
    
    Returns:
    
    the virtual end step
  - hasActionSteps
```
boolean hasActionSteps()
```
    Checks whether action steps are defined for the scenario.
    "Virtual" action steps are not considered here.
    
    Returns:
    
    true, if action steps exist, false otherwise
  - getActionSteps
```
java.util.List<? extends IActionStep> getActionSteps()
```
    Returns all action steps of the scenario.
    "Virtual" action steps are not returned here.
    The action steps are sorted in chronological order.
    
    Returns:
    
    an array containing the action steps
  - isExtensionScenario
```
boolean isExtensionScenario()
```
    Checks whether the scenario is an extension scenario (as opposed to a main scenario).
    
    Returns:
    
    true, if the scenario is an extension scenario, false if it is a main scenario
  - getExtendedScenario
```
IScenario getExtendedScenario()
```
    Returns the scenario which is extended by this scenario. Preconditions:the scenario must be an extension scenario, not a main scenario
    
    Returns:
    
    the extended scenario
  - getExtendingScenarioEndType
```
java.lang.String getExtendingScenarioEndType()
```
    Returns the end type of the scenario.
    The end type is a natural language expression like "after the forking step"/ "at the end with success". The state is returned in the language in which Cockpit is operating. Preconditions:the scenario must be an extension scenario, not a main scenario
    
    Returns:
    
    the extension end type
  - hasExtensionScenarios
```
boolean hasExtensionScenarios()
```
    Checks whether the scenario has extension scenarios.
    
    Returns:
    
    true, if extension scenarios exist, false otherwise
  - getExtensionScenarios
```
java.util.List<? extends IScenario> getExtensionScenarios()
```
    Returns all immediate extension scenarios of the scenario.
    The scenarios are sorted by id.
    
    Returns:
    
    array containing the extension scenarios
  - getExtensionScenarios
```
java.util.List<? extends IScenario> getExtensionScenarios(java.lang.String sortingProperty)
```
    Returns all immediate extension scenarios of the scenario.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting.
    
    Returns:
    
    array containing the extension scenarios
  - hasExtensionUseCases
```
boolean hasExtensionUseCases()
```
    Checks whether the scenario has extension use cases.
    
    Returns:
    
    true, if extension use cases exist, false otherwise
  - getExtensionUseCases
```
java.util.List<? extends IUseCase> getExtensionUseCases()
```
    Returns all immediate extension use cases of the scenario.
    The use cases are sorted by id.
    
    Returns:
    
    array containing the extension use cases
  - getExtensionUseCases
```
java.util.List<? extends IUseCase> getExtensionUseCases(int sortingCriterion)
```
    Returns all immediate extension use cases of the scenario.
    
    Parameters:
    
    sortingCriterion - specifies the criterion for sorting. Use the integer constants in IUseCaseDataProvider.
    
    Returns:
    
    array containing the extension use cases
  - getExtensionUseCases
```
java.util.List<? extends IUseCase> getExtensionUseCases(java.lang.String sortingProperty)
```
    Returns all immediate extension use cases of the scenario.
    
    Parameters:
    
    sortingProperty - specifies the custom property which shall be used as a criterion for sorting.
    
    Returns:
    
    array containing the extension use cases
  - toRecord
```
com.arcway.cockpit.docgen.provider.interfaces.IRecord toRecord()
```
    Converts this generic module data into a record.
    In addition to all fields documented at ICustomPropertiesAccess.toRecord(), in the created record, the following fields are filled accoring to the wrapped cockpit data:
    - IRecord.ID_KEY
    Specified by:
    
    toRecord in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData
    
    Specified by:
    
    toRecord in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
    
    Returns:
    
    converted cockpit project data

Interface IScenario

Method Summary

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

Method Detail

getUniqueIdentifier

getId

getGoal

getPrecondition

getInitialSituation

getPostconditionOnSuccess

getFinalStateOnSuccess

getPostconditionOnFailure

getFinalStateOnFailure

getTrigger

getTriggeringEvent

getUseCase

getActionStepEnd

hasActionSteps

getActionSteps

isExtensionScenario

getExtendedScenario

getExtendingScenarioEndType

hasExtensionScenarios

getExtensionScenarios

getExtensionScenarios

hasExtensionUseCases

getExtensionUseCases

getExtensionUseCases

getExtensionUseCases

toRecord