public interface IActionStep
extends com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess
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"
| 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.
|
getCategoryID, getCategoryLabel, getDateTimeProperty_MilliSecondsSince_01_01_1970, getFileProperty, getFileProperty, getFilePropertyAsBase64StringList, getFilePropertyAsFileName, getFilePropertyAsFileName, getFilePropertyAsRawStringList, getFilePropertyAsStringList, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringList, hasCustomPropertyValues, hasDefaultCategory, hasPropertyValue, readImageInfoOfFilePropertygetCommitVersion, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecordjava.lang.String getUniqueIdentifier()
getUniqueIdentifier in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitDatajava.lang.String getId()
java.util.List<java.lang.String> getDescription()
java.lang.String getTitle()
java.lang.String getActor()
IScenario getScenario()
boolean isStartOfExtensionScenarios()
java.util.List<? extends IScenario> getStartingExtensionScenarios()
java.util.List<? extends IScenario> getStartingExtensionScenarios(java.lang.String sortingProperty)
sortingProperty specifies the custom property which shall be used as a criterion for
sorting.
sortingProperty - the custom property which shall be used as a criterion for
sorting.boolean isStartOfExtensionUseCases()
java.util.List<? extends IUseCase> getStartingExtensionUseCases()
java.util.List<? extends IUseCase> getStartingExtensionUseCases(int sortingCriterion)
sortingCriterion specifies the criterion for sorting. Use the
integer constants in IUseCaseDataProvider.
sortingCriterion - the criterion for sortingjava.util.List<? extends IUseCase> getStartingExtensionUseCases(java.lang.String sortingProperty)
sortingProperty specifies the custom property which shall be used as a criterion for
sorting.
sortingProperty - the custom property which shall be used as a criterion for
sortingboolean isEndOfExtensionScenarios()
java.util.List<? extends IScenario> getEndingExtensionScenarios()
The scenarios are sorted by id.
java.util.List<? extends IScenario> getEndingExtensionScenarios(java.lang.String sortingProperty)
sortingProperty specifies the custom property which shall be used as a criterion for
sorting.
sortingProperty - the custom property which shall be used as a criterion for
sortingboolean isEndOfExtensionUseCases()
java.util.List<? extends IUseCase> getEndingExtensionUseCases()
The use cases are sorted by id.
java.util.List<? extends IUseCase> getEndingExtensionUseCases(int sortingCriterion)
sortingCriterion specifies the criterion for sorting. Use the
integer constants in IUseCaseDataProvider.
sortingCriterion - the criterion for sortingjava.util.List<? extends IUseCase> getEndingExtensionUseCases(java.lang.String sortingProperty)
sortingProperty specifies the custom property which shall be used as a criterion for
sorting.
sortingProperty - the custom property which shall be used as a criterion for
sortingboolean isLinkedWithUniqueElements()
java.util.List<? extends com.arcway.cockpit.docgen.provider.interfaces.IModelElement> getLinkedUniqueElements()
com.arcway.cockpit.docgen.provider.interfaces.IRecord toRecord()
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_KEYIRecord.DESCRIPTION_KEYIRecord.TITLE_KEYtoRecord in interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitDatatoRecord in interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess