Package net.officefloor.frame.api.function

Interface ManagedFunctionContext<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

All Superinterfaces:

FunctionFlowContext<F>

public interface ManagedFunctionContext<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>
extends FunctionFlowContext<F>

Context in which the ManagedFunction is done.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	doFlow(java.lang.String functionName, java.lang.Object parameter, FlowCallback callback)	Invokes a Flow by dynamically naming the initial ManagedFunction of the Flow.
java.lang.Object	getObject(int dependencyIndex)	Similar to getObject(Enum) except allows dynamically obtaining the dependencies.
java.lang.Object	getObject(O key)	Obtains the dependency object.
void	setNextFunctionArgument(java.lang.Object argument)	Specifies the next ManagedFunction argument.

Methods inherited from interface net.officefloor.frame.api.function.FunctionFlowContext

createAsynchronousFlow, doFlow, doFlow, getExecutor, getLogger

Method Detail

getObject

java.lang.Object getObject(O key)

Obtains the dependency object.

Parameters:

key - Key identifying the dependency.

Returns:

Dependency object.

getObject

java.lang.Object getObject(int dependencyIndex)

Similar to getObject(Enum) except allows dynamically obtaining the dependencies.

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

Parameters:

dependencyIndex - Index identifying the dependency.

Returns:

Dependency object.

doFlow

void doFlow(java.lang.String functionName,
            java.lang.Object parameter,
            FlowCallback callback)
     throws UnknownFunctionException,
            InvalidParameterTypeException

Invokes a Flow by dynamically naming the initial ManagedFunction of the Flow.

This method should not be preferred, as the other doFlow(...) methods are compile safe. This method however provides the similar functionality as per reflection - powerful yet compile unsafe.

The ManagedFunction reflective meta-data may be obtained from the Office made available via the OfficeAwareManagedFunctionFactory.

Parameters:

functionName - Name of ManagedFunction within the Office.

parameter - Parameter to the task. May be null.

callback - Optional FlowCallback that is invoked on completion of the Flow.

Throws:

UnknownFunctionException - Should no ManagedFunction be in the Office by the name.

InvalidParameterTypeException - Should the parameter be an invalid type for the ManagedFunction.

setNextFunctionArgument

void setNextFunctionArgument(java.lang.Object argument)
                      throws java.lang.Exception

Specifies the next ManagedFunction argument.

Parameters:

argument - Argument for the next ManagedFunction.

Throws:

java.lang.Exception - If invalid argument. Typically this is not a recoverable exception, so let propagate from the ManagedFunction or AsynchronousFlowCompletion.