org.requirementsascode

Class Flow

java.lang.Object

org.requirementsascode.Flow

public class Flow
extends java.lang.Object

A flow defines a sequence of steps that lead the user through a use case.

A flow either ends with the user reaching her/his goal, or terminates before, usually because of an exception that occurred.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<Condition>	getCondition() Convenience method that returns the condition of the flow.
java.util.Optional<FlowStep>	getFirstStep() Returns the first step of the flow
FlowPosition	getFlowPosition() Convenience method that returns the position of the flow (as defined e.g. by "InsteadOf").
Model	getModel() Returns the model that this element is part of.
java.lang.String	getName() Returns the name of the element.
java.util.List<FlowStep>	getSteps() Returns the steps contained in this flow.
UseCase	getUseCase() Returns the use case this flow is part of.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getUseCase

public UseCase getUseCase()

Returns the use case this flow is part of.

Returns:

the containing use case

getSteps

public java.util.List<FlowStep> getSteps()

Returns the steps contained in this flow. Do not modify the returned collection directly.

Returns:

a collection of the steps

getFirstStep

public java.util.Optional<FlowStep> getFirstStep()

Returns the first step of the flow

Returns:

the first step of the flow, or an empty optional if the flow has no steps.

getFlowPosition

public FlowPosition getFlowPosition()

Convenience method that returns the position of the flow (as defined e.g. by "InsteadOf").

Internally this calls the method of the same name of the first step in the flow.

Returns:

the flow position, or null if the flow is empty.

getCondition

public java.util.Optional<Condition> getCondition()

Convenience method that returns the condition of the flow.

Internally this calls the method of the same name of the first step in the flow.

Returns:

the condition

getName

public java.lang.String getName()

Returns the name of the element.

Returns:

the name

getModel

public Model getModel()

Returns the model that this element is part of.

Returns:

the model

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object