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

Interface IExtension

All Superinterfaces:

com.arcway.cockpit.docgen.provider.interfaces.ICockpitData, com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData

public interface IExtension
extends com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData

The IExtension object represents one occurrence of a use case extending a scenario from the COCKPIT use case module. It encapsulates the use case, the scenario and the steps at which the use case starts and ends.

Item type constant: "ucm.extension"

Method Summary

Modifier and Type	Method and Description
IScenario	getExtendedScenario() Returns the extended scenario of the extension.
IUseCase	getExtendingUseCase() Returns the extending use case of the extension.
java.lang.String	getExtensionEndType() Returns the end type of the extension.
IActionStep	getForkingStep() Returns the forking step of the extension, i.e. the step at which the extension use case starts.
IActionStep	getJoiningStep() Returns the joining step of the extension, i.e. the step at which the extension use case ends.

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, getUniqueIdentifier, toRecord, toRecord

Method Detail

getExtendingUseCase

IUseCase getExtendingUseCase()

Returns the extending use case of the extension.

Returns:

the use case

getExtendedScenario

IScenario getExtendedScenario()

Returns the extended scenario of the extension.

Returns:

the actor

getForkingStep

IActionStep getForkingStep()

Returns the forking step of the extension, i.e. the step at which the extension use case starts. The forking step must be one of the steps of the extended scenario.

Returns:

the forking step

getJoiningStep

IActionStep getJoiningStep()

Returns the joining step of the extension, i.e. the step at which the extension use case ends. The joining step must be one of the steps of the extended scenario.

Returns:

the joining step

getExtensionEndType

java.lang.String getExtensionEndType()

Returns the end type of the extension.

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.

Returns:

the extension end type