com.nomagic.magicdraw.usecasescenarios.scenarios

Interface FlowStep

All Superinterfaces:

ScenarioNode

@OpenApiAll
public interface FlowStep
extends ScenarioNode

Represents use case scenario flow step.

Method Summary

Modifier and Type	Method and Description
boolean	belongsToExtending() Indicates if this step belongs to extending.
boolean	belongsToIncluded() Indicates if this step belongs to included.
java.util.List<AlternativeCondition>	getAlternativeConditions() Gets flow step alternative conditions.
CallBehaviorAction	getCallBehaviorAction() Gets call behavior action which represents this step.
java.util.List<ExceptionType>	getExceptionTypes() Gets flow step exception types.
Activity	getExtendingActivity() Gets flow step extending activity.
UseCase	getExtendingUseCase() Gets flow step extending use case.
Activity	getIncludedActivity() Gets flow step included activity.
Activity	getIncludedExtendingActivity(boolean included) Gets flow step included/extending activity.
java.util.List<FlowStep>	getIncludedExtendingFlowSteps() Gets included/extending flows steps of this flow step.
UseCase	getIncludedUseCase() Gets flow step included use case.
AlternativeCondition	getParentAlternativeCondition() Gets parent alternative condition.
ExceptionType	getParentExceptionType() Gets parent exception type.
FlowStep	getParentFlowStep() Gets parent flow step.
java.util.List<ExceptionType>	getSortedExceptionTypes() Gets sorted flow step exception types.
boolean	isAlternativeStep() Indicates if this step is alternative flow step.
boolean	isExceptionalStep() Indicates if this step is exceptional flow step.
boolean	isExtending() Indicates if this step is extending.
boolean	isIncluded() Indicates if this step is included.
boolean	isIncludedExtending() Indicates if this step is included/extending.

Methods inherited from interface com.nomagic.magicdraw.usecasescenarios.scenarios.ScenarioNode

belongsToIncludedExtending, getElement, getEnd, getHumanType, getName, getParent, getParentContainer, getStart, isEditable, setName

Method Detail

getAlternativeConditions

java.util.List<AlternativeCondition> getAlternativeConditions()

Gets flow step alternative conditions.

Returns:

flow step alternative conditions.

isExceptionalStep

boolean isExceptionalStep()

Indicates if this step is exceptional flow step.

Returns:

true if this step is exceptional flow step, false otherwise.

isAlternativeStep

boolean isAlternativeStep()

Indicates if this step is alternative flow step.

Returns:

true if this step is alternative flow step, false otherwise.

getParentAlternativeCondition

AlternativeCondition getParentAlternativeCondition()

Gets parent alternative condition.

Returns:

parent alternative condition.

getParentExceptionType

ExceptionType getParentExceptionType()

Gets parent exception type.

Returns:

parent exception type.

getParentFlowStep

FlowStep getParentFlowStep()

Gets parent flow step.

Returns:

parent flow step.

getExceptionTypes

java.util.List<ExceptionType> getExceptionTypes()

Gets flow step exception types.

Returns:

flow step exception types.

getIncludedExtendingFlowSteps

java.util.List<FlowStep> getIncludedExtendingFlowSteps()

Gets included/extending flows steps of this flow step.

Returns:

included/extending flows steps of this flow step.

isIncludedExtending

boolean isIncludedExtending()

Indicates if this step is included/extending.

Returns:

true if this step is included/extending, false otherwise.

belongsToIncluded

boolean belongsToIncluded()

Indicates if this step belongs to included.

Returns:

true if this step belongs to included, false otherwise.

belongsToExtending

boolean belongsToExtending()

Indicates if this step belongs to extending.

Returns:

true if this step belongs to extending, false otherwise.

isIncluded

boolean isIncluded()

Indicates if this step is included.

Returns:

true if this step is included, false otherwise.

isExtending

boolean isExtending()

Indicates if this step is extending.

Returns:

true if this step is extending, false otherwise.

getIncludedActivity

Activity getIncludedActivity()

Gets flow step included activity.

Returns:

flow step included activity.

getIncludedUseCase

UseCase getIncludedUseCase()

Gets flow step included use case.

Returns:

flow step included use case.

getExtendingUseCase

UseCase getExtendingUseCase()

Gets flow step extending use case.

Returns:

flow step extending use case.

getExtendingActivity

Activity getExtendingActivity()

Gets flow step extending activity.

Returns:

flow step extending activity.

getIncludedExtendingActivity

Activity getIncludedExtendingActivity(boolean included)

Gets flow step included/extending activity.

Parameters:

included - true if included, false if extending.

Returns:

flow step included/extending activity if found, null otherwise.

getSortedExceptionTypes

java.util.List<ExceptionType> getSortedExceptionTypes()

Gets sorted flow step exception types.

Returns:

sorted flow step exception types.

getCallBehaviorAction

CallBehaviorAction getCallBehaviorAction()

Gets call behavior action which represents this step.

Returns:

call behavior action which represents this step.