net.officefloor.frame.api.build

Interface FlowNodeBuilder<F extends Enum<F>>

All Known Subinterfaces:

ManagedObjectTaskBuilder<D,F>, TaskBuilder<W,D,F>

All Known Implementing Classes:

TaskBuilderImpl

public interface FlowNodeBuilder<F extends Enum<F>>

Builds a node of a JobSequence and provides linking to other JobSequence instances.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
void	addEscalation(Class<? extends Throwable> typeOfCause, String taskName) Adds an EscalationFlow to the EscalationProcedure for the Task.
void	addEscalation(Class<? extends Throwable> typeOfCause, String workName, String taskName) Adds an EscalationFlow to the EscalationProcedure for the Task.
void	linkFlow(F key, String taskName, FlowInstigationStrategyEnum strategy, Class<?> argumentType) Links in a JobSequence by specifying the first Task of the JobSequence.
void	linkFlow(F key, String workName, String taskName, FlowInstigationStrategyEnum strategy, Class<?> argumentType) Links in a JobSequence by specifying the first Task of the JobSequence.
void	linkFlow(int flowIndex, String taskName, FlowInstigationStrategyEnum strategy, Class<?> argumentType) Links in a JobSequence by specifying the first Task of the JobSequence.
void	linkFlow(int flowIndex, String workName, String taskName, FlowInstigationStrategyEnum strategy, Class<?> argumentType) Links in a JobSequence by specifying the first Task of the JobSequence.
void	setNextTaskInFlow(String taskName, Class<?> argumentType) Specifies the next Task in the JobSequence (Task will reside on the same Work).
void	setNextTaskInFlow(String workName, String taskName, Class<?> argumentType) Specifies the next Task in the JobSequence (Task may reside on another Work).
void	setTeam(String officeTeamName) Specifies the Team by its Office registered name that that is responsible for this node.

Method Detail

setTeam

void setTeam(String officeTeamName)

Specifies the Team by its Office registered name that that is responsible for this node.

Parameters:

officeTeamName - Name of the Team within the Office.

setNextTaskInFlow

void setNextTaskInFlow(String taskName,
                       Class<?> argumentType)

Specifies the next Task in the JobSequence (Task will reside on the same Work).

Parameters:

taskName - Name of the next Task in the JobSequence.

argumentType - Type of argument passed to the next Task. May be null to indicate no argument.

setNextTaskInFlow

void setNextTaskInFlow(String workName,
                       String taskName,
                       Class<?> argumentType)

Specifies the next Task in the JobSequence (Task may reside on another Work).

Parameters:

workName - Name of Work containing the Task.

taskName - Name of the next Task in the JobSequence.

argumentType - Type of argument passed to the next Task. May be null to indicate no argument.

linkFlow

void linkFlow(F key,
              String taskName,
              FlowInstigationStrategyEnum strategy,
              Class<?> argumentType)

Links in a JobSequence by specifying the first Task of the JobSequence.

Parameters:

key - Key identifying the JobSequence.

taskName - Name of Task that resides on same Work as this Task.

strategy - Strategy to instigate the JobSequence.

argumentType - Type of argument passed to the instigated JobSequence. May be null to indicate no argument.

linkFlow

void linkFlow(int flowIndex,
              String taskName,
              FlowInstigationStrategyEnum strategy,
              Class<?> argumentType)

Links in a JobSequence by specifying the first Task of the JobSequence.

Parameters:

flowIndex - Index identifying the JobSequence.

taskName - Name of Task that resides on same Work as this Task.

strategy - Strategy to instigate the JobSequence.

argumentType - Type of argument passed to the instigated JobSequence. May be null to indicate no argument.

linkFlow

void linkFlow(F key,
              String workName,
              String taskName,
              FlowInstigationStrategyEnum strategy,
              Class<?> argumentType)

Links in a JobSequence by specifying the first Task of the JobSequence.

Parameters:

key - Key identifying the JobSequence.

workName - Name of the Work that the first Task of the JobSequence resides on.

taskName - Name of Task that resides on a different Work as this Task.

strategy - Strategy to instigate the JobSequence.

argumentType - Type of argument passed to the instigated JobSequence. May be null to indicate no argument.

linkFlow

void linkFlow(int flowIndex,
              String workName,
              String taskName,
              FlowInstigationStrategyEnum strategy,
              Class<?> argumentType)

Links in a JobSequence by specifying the first Task of the JobSequence.

Parameters:

flowIndex - Index identifying the JobSequence.

workName - Name of the Work that the first Task of the JobSequence resides on.

taskName - Name of Task that resides on a different Work as this Task.

strategy - Strategy to instigate the JobSequence.

argumentType - Type of argument passed to the instigated JobSequence. May be null to indicate no argument.

addEscalation

void addEscalation(Class<? extends Throwable> typeOfCause,
                   String taskName)

Adds an EscalationFlow to the EscalationProcedure for the Task.

The order in which the EscalationFlow instances are added is the order in which they are checked for handling escalation. Only one EscalationFlow is used to handle escalation and the first one covering the cause will be used.

Parameters:

typeOfCause - Type of cause handled by this EscalationFlow.

taskName - Name of the Task that resides on the same Work as this Task.

See Also:

addEscalation(Class, String, String)

addEscalation

void addEscalation(Class<? extends Throwable> typeOfCause,
                   String workName,
                   String taskName)

Adds an EscalationFlow to the EscalationProcedure for the Task.

Parameters:

typeOfCause - Type of cause handled by this EscalationFlow.

workName - Name of the Work that the first Task of the JobSequence resides on.

taskName - Name of Task that resides on a different Work as this Task.

See Also:

addEscalation(Class, String)