Package net.officefloor.frame.api.build

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

All Superinterfaces:

FlowBuilder<F>, FunctionBuilder<F>

All Known Implementing Classes:

ManagedFunctionBuilderImpl

public interface ManagedFunctionBuilder<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>
extends FlowBuilder<F>

Builder of the ManagedFunction.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	addAnnotation(java.lang.Object annotation)	Adds the annotation for this ManagedFunction.
void	addGovernance(java.lang.String governanceName)	Adds Governance to this ManagedFunction.
DependencyMappingBuilder	addManagedObject(java.lang.String functionManagedObjectName, java.lang.String officeManagedObjectName)	Adds a ManagedObject bound to this ManagedFunction.
void	linkManagedObject(int managedObjectIndex, java.lang.String scopeManagedObjectName, java.lang.Class<?> objectType)	Links in a ManagedObject to this ManagedFunction.
void	linkManagedObject(O key, java.lang.String scopeManagedObjectName, java.lang.Class<?> objectType)	Links in a ManagedObject to this ManagedFunction.
void	linkParameter(int index, java.lang.Class<?> parameterType)	Links in the parameter for this ManagedFunction.
void	linkParameter(O key, java.lang.Class<?> parameterType)	Links in the parameter for this ManagedFunction.
<E,f extends java.lang.Enum<f>,G extends java.lang.Enum<G>> AdministrationBuilder<f,G>	postAdminister(java.lang.String administrationName, java.lang.Class<E> extension, AdministrationFactory<E,f,G> administrationFactory)	Adds Administration to be undertaken after this ManagedFunction.
<E,f extends java.lang.Enum<f>,G extends java.lang.Enum<G>> AdministrationBuilder<f,G>	preAdminister(java.lang.String administrationName, java.lang.Class<E> extension, AdministrationFactory<E,f,G> administrationFactory)	Adds Administration to be undertaken before this ManagedFunction.
void	setAsynchronousFlowTimeout(long timeout)	Specifies the timeout to for AsynchronousFlow instances for this ManagedFunction.

Methods inherited from interface net.officefloor.frame.api.build.FlowBuilder

setNextFunction

Methods inherited from interface net.officefloor.frame.api.build.FunctionBuilder

addEscalation, linkFlow, linkFlow, setResponsibleTeam

Method Detail

addAnnotation

void addAnnotation(java.lang.Object annotation)

Adds the annotation for this ManagedFunction.

This is exposed as is on the FunctionManager interface for this ManagedFunction to allow reflective:

1. identification of this ManagedFunction (e.g. can check on type of this object)
2. means to trigger functionality on this ManagedFunction (e.g. can expose functionality to be invoked)

Parameters:

annotation - Annotation.

linkParameter

void linkParameter(O key,
                   java.lang.Class<?> parameterType)

Links in the parameter for this ManagedFunction.

Parameters:

key - Key identifying the parameter.

parameterType - Type of the parameter.

linkParameter

void linkParameter(int index,
                   java.lang.Class<?> parameterType)

Links in the parameter for this ManagedFunction.

Parameters:

index - Index identifying the parameter.

parameterType - Type of the parameter.

linkManagedObject

void linkManagedObject(O key,
                       java.lang.String scopeManagedObjectName,
                       java.lang.Class<?> objectType)

Links in a ManagedObject to this ManagedFunction.

Parameters:

key - Key identifying the ManagedObject.

scopeManagedObjectName - Name of the ManagedObject within the ManagedObjectScope.

objectType - Type required by the ManagedFunction.

linkManagedObject

void linkManagedObject(int managedObjectIndex,
                       java.lang.String scopeManagedObjectName,
                       java.lang.Class<?> objectType)

Links in a ManagedObject to this ManagedFunction.

Parameters:

managedObjectIndex - Index of the ManagedObject.

scopeManagedObjectName - Name of the ManagedObject within the ManagedObjectScope.

objectType - Type required by the ManagedFunction.

preAdminister

<E,f extends java.lang.Enum<f>,G extends java.lang.Enum<G>> AdministrationBuilder<f,G> preAdminister(java.lang.String administrationName,
                                                                                                                       java.lang.Class<E> extension,
                                                                                                                       AdministrationFactory<E,f,G> administrationFactory)

Adds Administration to be undertaken before this ManagedFunction.

Type Parameters:

E - Extension type.

f - Flow key type.

G - Governance key type.

Parameters:

administrationName - Name of the Administration.

extension - Extension type for Administration.

administrationFactory - AdministrationFactory.

Returns:

AdministrationBuilder to build the Administration.

postAdminister

<E,f extends java.lang.Enum<f>,G extends java.lang.Enum<G>> AdministrationBuilder<f,G> postAdminister(java.lang.String administrationName,
                                                                                                                        java.lang.Class<E> extension,
                                                                                                                        AdministrationFactory<E,f,G> administrationFactory)

Adds Administration to be undertaken after this ManagedFunction.

Type Parameters:

E - Extension type.

f - Flow key type.

G - Governance key type.

Parameters:

administrationName - Name of the Administration.

extension - Extension type for Administration.

administrationFactory - AdministrationFactory.

Returns:

AdministrationBuilder to build the Administration.

addGovernance

void addGovernance(java.lang.String governanceName)

Adds Governance to this ManagedFunction.

In other words, to execute this ManagedFunction the Governance will be automatically activated before the ManagedFunction is executed (or stay active from previous ManagedFunction).

The Governance will be:

1. enforced when either a ManagedFunction does not require the Governance or the ThreadState completes.
3. disregarded when an escalation occurs to a ManagedFunction not requiring the Governance. Note that this does allow the Governance to stay active should the Escalation ManagedFunction require the Governance.
4. Manually managed by an Administration

Parameters:

governanceName - Name of the Governance.

addManagedObject

DependencyMappingBuilder addManagedObject(java.lang.String functionManagedObjectName,
                                          java.lang.String officeManagedObjectName)

Adds a ManagedObject bound to this ManagedFunction.

Dependency scope:

1. Other ManagedObject instances added via this method.
2. ThreadState bound ManagedObject instances.
3. ProcessState bound ManagedObject instances.

Parameters:

functionManagedObjectName - Name of the ManagedObject to be referenced locally by this ManagedFunction.

officeManagedObjectName - Name of the ManagedObject referenced locally within the Office.

Returns:

DependencyMappingBuilder.

setAsynchronousFlowTimeout

void setAsynchronousFlowTimeout(long timeout)

Specifies the timeout to for AsynchronousFlow instances for this ManagedFunction.

Parameters:

timeout - Timeout.