org.requirementsascode

Class UseCase

java.lang.Object

org.requirementsascode.UseCase

public class UseCase
extends java.lang.Object

A use case, as part of a model.

As an example, a use case for an ATM is "Get cash". As another example, a use case for an online flight reservation system is "Book flight".

The use case itself defines no behavior. The steps that are part of the use case define the behavior of the use case. As steps are often performed one after the other, in sequence, they are grouped in use case flows.

Method Summary

Modifier and Type	Method and Description
Flow	findFlow(java.lang.String flowName) Finds the flow with the specified name, contained in this use case.
Step	findStep(java.lang.String stepName) Finds the step with the specified name, contained in this use case.
Flow	getBasicFlow() The basic flow defines the 'happy day scenario' of the use case: no exceptions are handled in it, all steps are assumed to go well.
java.util.Collection<Flow>	getFlows() Returns the flows contained in this use case.
Model	getModel() Returns the model that this element is part of.
java.lang.String	getName() Returns the name of the element.
java.util.Collection<Step>	getSteps() Returns the steps contained in this use case.
boolean	hasFlow(java.lang.String flowName) Checks whether this use case contains the specified flow.
boolean	hasStep(java.lang.String stepName) Checks whether this use case contains the specified step.
Flow	newFlow(java.lang.String flowName) Creates a new flow in this use case.
FlowlessStep	newFlowlessStep(java.lang.String stepName, Condition optionalCondition) Creates a step that is independent of a flow.
InterruptableFlowStep	newInterruptableFlowStep(java.lang.String stepName, Flow flow) Creates a step that can be "interrupted", that is: interrupting steps are performed instead of this step when their flow position is correct and their condition is fulfilled.
InterruptingFlowStep	newInterruptingFlowStep(java.lang.String stepName, Flow flow, FlowPosition flowPosition, Condition condition) Creates a new step that can interrupt other flows.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getBasicFlow

public Flow getBasicFlow()

The basic flow defines the 'happy day scenario' of the use case: no exceptions are handled in it, all steps are assumed to go well.

The basic flow is a sequence of steps that lead the user to the user's goal. There is exactly one basic flow per use case.

Returns:

the basic flow of the use case

hasFlow

public boolean hasFlow(java.lang.String flowName)

Checks whether this use case contains the specified flow.

Parameters:

flowName - the name of the flow whose existence to check

Returns:

true if this use case contains the specified flow, false otherwise

hasStep

public boolean hasStep(java.lang.String stepName)

Checks whether this use case contains the specified step.

Parameters:

stepName - the name of the step whose existence to check

Returns:

true if this use case contains the specified step, false otherwise

newFlow

public Flow newFlow(java.lang.String flowName)

Creates a new flow in this use case.

Parameters:

flowName - the name of the flow to be created.

Returns:

the newly created flow

Throws:

ElementAlreadyInModel - if a flow with the specified name already exists in the use case

newInterruptingFlowStep

public InterruptingFlowStep newInterruptingFlowStep(java.lang.String stepName,
                                                    Flow flow,
                                                    FlowPosition flowPosition,
                                                    Condition condition)

Creates a new step that can interrupt other flows. This is the first step of a flow with a defined flow position and/or condition. The flow position and condition are the same as defined for the flow.

Parameters:

stepName - the name of the step

flow - the flow the step shall belong to

flowPosition - the flow position, may be null, meaning: anytime.

condition - the condition, may be null if there is none.

Returns:

the newly created step

newInterruptableFlowStep

public InterruptableFlowStep newInterruptableFlowStep(java.lang.String stepName,
                                                      Flow flow)

Creates a step that can be "interrupted", that is: interrupting steps are performed instead of this step when their flow position is correct and their condition is fulfilled. All steps of a flow are interruptable steps, with the potential exception of the first step. The first step is interruptable as well iff no flow position and no when condition are specified. So, for example, if you build builder.useCase("UC1").basicFlow().step("S1"), then S1 is an interruptable step as well.

Parameters:

stepName - the name of the step

flow - the flow the step shall belong to

Returns:

the newly created step

newFlowlessStep

public FlowlessStep newFlowlessStep(java.lang.String stepName,
                                    Condition optionalCondition)

Creates a step that is independent of a flow.

Parameters:

stepName - the name of the step

optionalCondition - the condition of the flow, or null if the step is unconditional.

Returns:

the newly created step

findFlow

public Flow findFlow(java.lang.String flowName)

Finds the flow with the specified name, contained in this use case.

Parameters:

flowName - the name of the flow to look for

Returns:

the flow if found

Throws:

NoSuchElementInModel - if no flow with the specified flowName is found in the current use case

findStep

public Step findStep(java.lang.String stepName)

Finds the step with the specified name, contained in this use case.

Parameters:

stepName - the name of the step to look for

Returns:

the step if found

Throws:

NoSuchElementInModel - if no step with the specified stepName is found in the current use case

getFlows

public java.util.Collection<Flow> getFlows()

Returns the flows contained in this use case.

Returns:

a collection of the flows

getSteps

public java.util.Collection<Step> getSteps()

Returns the steps contained in this use case.

Returns:

a collection of the steps

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