Package net.officefloor.frame.api.function

Interface FunctionFlowContext<F extends Enum<F>>

All Known Subinterfaces:

AdministrationContext<E,F,G>, GovernanceContext<F>, ManagedFunctionContext<O,F>

public interface FunctionFlowContext<F extends Enum<F>>

Context for the Flow instances from the ManagedFunctionLogic.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
AsynchronousFlow	createAsynchronousFlow()	Creates an AsynchronousFlow that must be completed before any further Flow is executed.
void	doFlow(int flowIndex, Object parameter, FlowCallback callback)	Similar to doFlow(Enum, Object, FlowCallback) except that allows dynamic instigation of Flow instances.
void	doFlow(F key, Object parameter, FlowCallback callback)	Instigates a Flow to be run from the ManagedFunctionLogic.
Executor	getExecutor()	Obtains the Executor to run on another Thread.
Logger	getLogger()	Obtains the Logger.

Method Details

getLogger

Logger getLogger()

Obtains the Logger.

Returns:

Logger.

doFlow

void doFlow(F key,
 Object parameter,
 FlowCallback callback)

Instigates a Flow to be run from the ManagedFunctionLogic.

Parameters:

key - Key identifying the Flow to instigate.

parameter - Parameter for the first ManagedFunction of the Flow.

callback - Optional FlowCallback. May be null.

doFlow

void doFlow(int flowIndex,
 Object parameter,
 FlowCallback callback)

Similar to doFlow(Enum, Object, FlowCallback) except that allows dynamic instigation of Flow instances.

In other words, an Enum is not required to define the possible Flow instances available.

Parameters:

flowIndex - Index identifying the Flow to instigate.

parameter - Parameter for the first ManagedFunction of the Flow.

callback - Optional FlowCallback. May be null.

createAsynchronousFlow

AsynchronousFlow createAsynchronousFlow()

Creates an AsynchronousFlow that must be completed before any further Flow is executed.

Returns:

AsynchronousFlow that must be completed.

getExecutor

Executor getExecutor()

Obtains the Executor to run on another Thread.

Runnable instances provided to this Executor will always be executed on another Thread. This allows breaking thread stack execution.

Note that the returned Executor is a singleton per OfficeFloor. Therefore, be careful to not tie up all its Thread instances with blocking / long running Runnable instances. Preference should be to use ManagedFunction instances where appropriate Thread injection can manage execution.

Returns:

Executor to run Runnable on another Thread.