io.nflow.engine.workflow.definition

Class AbstractWorkflowDefinition<S extends WorkflowState>

java.lang.Object

io.nflow.engine.model.ModelObject

io.nflow.engine.workflow.definition.AbstractWorkflowDefinition<S>

Direct Known Subclasses:

WorkflowDefinition

public abstract class AbstractWorkflowDefinition<S extends WorkflowState>
extends ModelObject

The base class for all workflow definitions.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,List<String>>	allowedTransitions
protected Map<String,WorkflowState>	failureTransitions

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWorkflowDefinition(String type, S initialState, S errorState)
protected	AbstractWorkflowDefinition(String type, S initialState, S errorState, WorkflowSettings settings)
protected	AbstractWorkflowDefinition(String type, S initialState, S errorState, WorkflowSettings settings, Map<String,WorkflowStateMethod> stateMethods)

Method Summary

Modifier and Type	Method and Description
Map<String,List<String>>	getAllowedTransitions() Return allowed transitions between the states of the workflow.
String	getDescription() Return the description of the workflow.
S	getErrorState() Return the generic error state of the workflow.
Map<String,WorkflowState>	getFailureTransitions() Return transitions from states to failure states.
S	getInitialState() Return the initial state of the workflow.
WorkflowStateMethod	getMethod(String stateName) Returns the workflow state method for the given state name.
String	getName() Return the name of the workflow.
WorkflowSettings	getSettings() Return the workflow settings.
WorkflowState	getState(String state) Returns the workflow state for the given state name.
abstract Set<S>	getStates() Return all possible states of the workflow.
Map<Integer,String>	getSupportedSignals() Return signals supported by this workflow.
String	getType() Return the type of the workflow.
boolean	isAllowedNextAction(WorkflowInstance instance, NextAction nextAction) Return true if the given nextAction is permitted for given instance.
boolean	isStartState(String state) Check if the given state is a valid start state.
protected AbstractWorkflowDefinition<S>	permit(S originState, S targetState) Add a state transition to the allowed transitions.
protected AbstractWorkflowDefinition<S>	permit(S originState, S targetState, S failureState) Add a state and failure state transitions to the allowed transitions.
void	setDescription(String description) Set the description of the workflow.
void	setName(String name) Set the name of the workflow.

Methods inherited from class io.nflow.engine.model.ModelObject

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

allowedTransitions

protected final Map<String,List<String>> allowedTransitions

failureTransitions

protected final Map<String,WorkflowState> failureTransitions

Constructor Detail

AbstractWorkflowDefinition

protected AbstractWorkflowDefinition(String type,
                                     S initialState,
                                     S errorState)

AbstractWorkflowDefinition

protected AbstractWorkflowDefinition(String type,
                                     S initialState,
                                     S errorState,
                                     WorkflowSettings settings)

AbstractWorkflowDefinition

protected AbstractWorkflowDefinition(String type,
                                     S initialState,
                                     S errorState,
                                     WorkflowSettings settings,
                                     Map<String,WorkflowStateMethod> stateMethods)

Method Detail

getName

public String getName()

Return the name of the workflow.

Returns:

The name.

setName

public void setName(String name)

Set the name of the workflow.

Parameters:

name - The name.

getDescription

public String getDescription()

Return the description of the workflow.

Returns:

The description.

setDescription

public void setDescription(String description)

Set the description of the workflow.

Parameters:

description - The description.

getType

public String getType()

Return the type of the workflow.

Returns:

The type.

getInitialState

public S getInitialState()

Return the initial state of the workflow.

Returns:

Workflow state.

getErrorState

public S getErrorState()

Return the generic error state of the workflow.

Returns:

Workflow state.

getStates

public abstract Set<S> getStates()

Return all possible states of the workflow.

Returns:

Set of workflow states.

getAllowedTransitions

public Map<String,List<String>> getAllowedTransitions()

Return allowed transitions between the states of the workflow.

Returns:

Map from origin states to a list of target states.

getFailureTransitions

public Map<String,WorkflowState> getFailureTransitions()

Return transitions from states to failure states.

Returns:

Map from origin state to failure state.

permit

protected AbstractWorkflowDefinition<S> permit(S originState,
                                               S targetState)

Add a state transition to the allowed transitions.

Parameters:

originState - The origin state.

targetState - The target state.

Returns:

This.

permit

protected AbstractWorkflowDefinition<S> permit(S originState,
                                               S targetState,
                                               S failureState)

Add a state and failure state transitions to the allowed transitions.

Parameters:

originState - The origin state.

targetState - The target state.

failureState - The failure state.

Returns:

This.

getSettings

public WorkflowSettings getSettings()

Return the workflow settings.

Returns:

Workflow settings.

getMethod

public WorkflowStateMethod getMethod(String stateName)

Returns the workflow state method for the given state name.

Parameters:

stateName - The name of the workflow state.

Returns:

The workflow state method, or null if not found.

getState

public WorkflowState getState(String state)

Returns the workflow state for the given state name.

Parameters:

state - The name of the workflow state.

Returns:

The workflos state matching the state name.

Throws:

IllegalStateException - when a matching state can not be found.

isStartState

public boolean isStartState(String state)

Check if the given state is a valid start state.

Parameters:

state - The name of the workflow state.

Returns:

True if the given state is a valid start date, false otherwise.

Throws:

IllegalStateException - if the given state name does not match any state.

isAllowedNextAction

public boolean isAllowedNextAction(WorkflowInstance instance,
                                   NextAction nextAction)

Return true if the given nextAction is permitted for given instance.

Parameters:

instance - The workflow instance for which the action is checked.

nextAction - The action to be checked.

Returns:

True if the nextAction is permitted, false otherwise.

getSupportedSignals

public Map<Integer,String> getSupportedSignals()

Return signals supported by this workflow. Default implementation returns empty map, override this in your workflow definition that supports signals.

Returns:

Signals and their descriptions.