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

Interface IActionStep

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 IActionStep
extends com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

The IActionStep object allows to read attribute values of an action step from the COCKPIT use case module. Starting with this object, you can get references to extension scenarios and extension use cases.

Item type constant: "ucm.actionStep"

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActor() Returns the name of the actor who carries out the action step.
java.util.List<java.lang.String>	getDescription() Returns the 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.
java.lang.String	getId() Returns the id of the actions step.
java.util.List<? extends com.arcway.cockpit.docgen.provider.interfaces.IModelElement>	getLinkedUniqueElements() Returns a list with the linked unique elements or an empty list if non exists.
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<? extends IUseCase>	getStartingExtensionUseCases(java.lang.String sortingProperty) Returns the extension use cases starting at the action step.
java.lang.String	getTitle() Returns the title of the action step.
java.lang.String	getUniqueIdentifier() Returns a unique identifier that uniquely identifies this object within its project.
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	isLinkedWithUniqueElements() Returns whether the action step is linked with unique elements.
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.
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 actions step.

Returns:

the id

getDescription

java.util.List<java.lang.String> getDescription()

Returns the description. If the description consists of multiple paragraphs (ENTER) each paragraph is represented by an element in the String array.

Returns:

the description as array of paragraphs

getTitle

java.lang.String getTitle()

Returns the title of the action step.

Returns:

the title

getActor

java.lang.String getActor()

Returns the name of the actor who carries out the action step.

Returns:

the actor

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.

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.

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

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.

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.

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

Parameters:

sortingCriterion - the criterion for sorting

Returns:

array containing the extension use cases

getStartingExtensionUseCases

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

Returns the extension use cases starting at the action step.

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

Parameters:

sortingProperty - 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.

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

Parameters:

sortingProperty - 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.

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

Parameters:

sortingCriterion - the criterion for sorting

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.

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

Parameters:

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

Returns:

array containing the extension use cases

isLinkedWithUniqueElements

boolean isLinkedWithUniqueElements()

Returns whether the action step is linked with unique elements.

Returns:

whether the action step is linked to unique elements

getLinkedUniqueElements

java.util.List<? extends com.arcway.cockpit.docgen.provider.interfaces.IModelElement> getLinkedUniqueElements()

Returns a list with the linked unique elements or an empty list if non exists.

Returns:

a list with the linked unique elements

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
• IRecord.DESCRIPTION_KEY
• IRecord.TITLE_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