Package net.officefloor.frame.impl.construct.managedfunction

Class ManagedFunctionBuilderImpl<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

java.lang.Object

net.officefloor.frame.impl.construct.function.AbstractFunctionBuilder<F>

net.officefloor.frame.impl.construct.managedfunction.ManagedFunctionBuilderImpl<O,F>

All Implemented Interfaces:

FlowBuilder<F>, FunctionBuilder<F>, ManagedFunctionBuilder<O,F>, FunctionConfiguration<F>, ManagedFunctionConfiguration<O,F>

public class ManagedFunctionBuilderImpl<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>
extends AbstractFunctionBuilder<F>
implements ManagedFunctionBuilder<O,F>, ManagedFunctionConfiguration<O,F>

Implementation of the ManagedFunctionBuilder.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
ManagedFunctionBuilderImpl(java.lang.String functionName, ManagedFunctionFactory<O,F> functionFactory)	Initiate.

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.
java.lang.Object[]	getAnnotations()	Obtains the annotations for the ManagedFunction.
long	getAsynchronousFlowTimeout()	Obtains the timeout for any AsynchronousFlow instigated.
java.lang.String	getFunctionName()	Obtains the name of this ManagedFunction.
ManagedFunctionGovernanceConfiguration[]	getGovernanceConfiguration()	Obtains the configuration of the Governance instances for this ManagedFunction.
ManagedFunctionFactory<O,F>	getManagedFunctionFactory()	Obtains the ManagedFunctionFactory for the ManagedFunction.
ManagedObjectConfiguration<?>[]	getManagedObjectConfiguration()	Obtains the configuration of the ManagedFunction bound ManagedObject instances.
ManagedFunctionReference	getNextFunction()	Obtains the reference to the next ManagedFunction.
ManagedFunctionObjectConfiguration<O>[]	getObjectConfiguration()	Obtains the configuration of the dependent Object instances for this ManagedFunction.
AdministrationConfiguration<?,?,?>[]	getPostAdministration()	Obtains the listing of the Administration to be done after the ManagedFunction is executed.
AdministrationConfiguration<?,?,?>[]	getPreAdministration()	Obtains the listing of the Administration to be done before the ManagedFunction is executed.
void	linkManagedObject(int index, 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.
void	setNextFunction(java.lang.String functionName, java.lang.Class<?> argumentType)	Specifies the next ManagedFunction to be executed.

Methods inherited from class net.officefloor.frame.impl.construct.function.AbstractFunctionBuilder

addEscalation, getEscalations, getFlowConfiguration, getResponsibleTeamName, linkFlow, linkFlow, setResponsibleTeam

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addEscalation, linkFlow, linkFlow, setResponsibleTeam

Methods inherited from interface net.officefloor.frame.internal.configuration.FunctionConfiguration

getEscalations, getFlowConfiguration, getResponsibleTeamName

Constructor Detail

ManagedFunctionBuilderImpl

public ManagedFunctionBuilderImpl(java.lang.String functionName,
                                  ManagedFunctionFactory<O,F> functionFactory)

Initiate.

Parameters:

functionName - Name of this ManagedFunction.

functionFactory - ManagedFunctionFactory.

Method Detail

addAnnotation

public void addAnnotation(java.lang.Object annotation)

Description copied from interface: ManagedFunctionBuilder

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)

Specified by:

addAnnotation in interface ManagedFunctionBuilder<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Parameters:

annotation - Annotation.

setNextFunction

public void setNextFunction(java.lang.String functionName,
                            java.lang.Class<?> argumentType)

Description copied from interface: FlowBuilder

Specifies the next ManagedFunction to be executed.

Specified by:

setNextFunction in interface FlowBuilder<O extends java.lang.Enum<O>>

Parameters:

functionName - Name of the next ManagedFunction.

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

linkParameter

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

Description copied from interface: ManagedFunctionBuilder

Links in the parameter for this ManagedFunction.

Specified by:

linkParameter in interface ManagedFunctionBuilder<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Parameters:

key - Key identifying the parameter.

parameterType - Type of the parameter.

linkParameter

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

Description copied from interface: ManagedFunctionBuilder

Links in the parameter for this ManagedFunction.

Specified by:

linkParameter in interface ManagedFunctionBuilder<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Parameters:

index - Index identifying the parameter.

parameterType - Type of the parameter.

linkManagedObject

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

Description copied from interface: ManagedFunctionBuilder

Links in a ManagedObject to this ManagedFunction.

Specified by:

linkManagedObject in interface ManagedFunctionBuilder<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Parameters:

key - Key identifying the ManagedObject.

scopeManagedObjectName - Name of the ManagedObject within the ManagedObjectScope.

objectType - Type required by the ManagedFunction.

linkManagedObject

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

Description copied from interface: ManagedFunctionBuilder

Links in a ManagedObject to this ManagedFunction.

Specified by:

linkManagedObject in interface ManagedFunctionBuilder<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Parameters:

index - Index of the ManagedObject.

scopeManagedObjectName - Name of the ManagedObject within the ManagedObjectScope.

objectType - Type required by the ManagedFunction.

addManagedObject

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

Description copied from interface: ManagedFunctionBuilder

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.

Specified by:

addManagedObject in interface ManagedFunctionBuilder<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

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.

preAdminister

public <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)

Description copied from interface: ManagedFunctionBuilder

Adds Administration to be undertaken before this ManagedFunction.

Specified by:

preAdminister in interface ManagedFunctionBuilder<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

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

public <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)

Description copied from interface: ManagedFunctionBuilder

Adds Administration to be undertaken after this ManagedFunction.

Specified by:

postAdminister in interface ManagedFunctionBuilder<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

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

public void addGovernance(java.lang.String governanceName)

Description copied from interface: ManagedFunctionBuilder

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

Specified by:

addGovernance in interface ManagedFunctionBuilder<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Parameters:

governanceName - Name of the Governance.

setAsynchronousFlowTimeout

public void setAsynchronousFlowTimeout(long timeout)

Description copied from interface: ManagedFunctionBuilder

Specifies the timeout to for AsynchronousFlow instances for this ManagedFunction.

Specified by:

setAsynchronousFlowTimeout in interface ManagedFunctionBuilder<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Parameters:

timeout - Timeout.

getFunctionName

public java.lang.String getFunctionName()

Description copied from interface: ManagedFunctionConfiguration

Obtains the name of this ManagedFunction.

Specified by:

getFunctionName in interface ManagedFunctionConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Name of this ManagedFunction.

getManagedFunctionFactory

public ManagedFunctionFactory<O,F> getManagedFunctionFactory()

Description copied from interface: ManagedFunctionConfiguration

Obtains the ManagedFunctionFactory for the ManagedFunction.

Specified by:

getManagedFunctionFactory in interface ManagedFunctionConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

ManagedFunctionFactory.

getAnnotations

public java.lang.Object[] getAnnotations()

Description copied from interface: ManagedFunctionConfiguration

Obtains the annotations for the ManagedFunction.

Specified by:

getAnnotations in interface ManagedFunctionConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Annotations for the ManagedFunction.

getObjectConfiguration

public ManagedFunctionObjectConfiguration<O>[] getObjectConfiguration()

Description copied from interface: ManagedFunctionConfiguration

Obtains the configuration of the dependent Object instances for this ManagedFunction.

Specified by:

getObjectConfiguration in interface ManagedFunctionConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Configuration of the dependent Object instances for this ManagedFunction.

getGovernanceConfiguration

public ManagedFunctionGovernanceConfiguration[] getGovernanceConfiguration()

Description copied from interface: ManagedFunctionConfiguration

Obtains the configuration of the Governance instances for this ManagedFunction.

Specified by:

getGovernanceConfiguration in interface ManagedFunctionConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Configuration of the Governance for this ManagedFunction.

getNextFunction

public ManagedFunctionReference getNextFunction()

Description copied from interface: ManagedFunctionConfiguration

Obtains the reference to the next ManagedFunction.

Specified by:

getNextFunction in interface ManagedFunctionConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Reference to the next ManagedFunction.

getPreAdministration

public AdministrationConfiguration<?,?,?>[] getPreAdministration()

Description copied from interface: ManagedFunctionConfiguration

Obtains the listing of the Administration to be done before the ManagedFunction is executed.

Specified by:

getPreAdministration in interface ManagedFunctionConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Listing of the Administration to be done before the ManagedFunction is executed.

getPostAdministration

public AdministrationConfiguration<?,?,?>[] getPostAdministration()

Description copied from interface: ManagedFunctionConfiguration

Obtains the listing of the Administration to be done after the ManagedFunction is executed.

Specified by:

getPostAdministration in interface ManagedFunctionConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Listing of the Administration to be done after the ManagedFunction is executed.

getManagedObjectConfiguration

public ManagedObjectConfiguration<?>[] getManagedObjectConfiguration()

Description copied from interface: ManagedFunctionConfiguration

Obtains the configuration of the ManagedFunction bound ManagedObject instances.

Specified by:

getManagedObjectConfiguration in interface ManagedFunctionConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Listing of the ManagedObject configuration for this ManagedFunction.

getAsynchronousFlowTimeout

public long getAsynchronousFlowTimeout()

Description copied from interface: ManagedFunctionConfiguration

Obtains the timeout for any AsynchronousFlow instigated.

Specified by:

getAsynchronousFlowTimeout in interface ManagedFunctionConfiguration<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Timeout for any AsynchronousFlow instigated.