Package net.officefloor.frame.impl.execute.managedfunction

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

java.lang.Object

net.officefloor.frame.impl.execute.managedfunction.ManagedFunctionMetaDataImpl<O,F>

All Implemented Interfaces:

ManagedFunctionLogicMetaData, ManagedFunctionMetaData<O,F>

public class ManagedFunctionMetaDataImpl<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>
extends java.lang.Object
implements ManagedFunctionMetaData<O,F>

Meta-data of a ManagedFunction.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor

Description

ManagedFunctionMetaDataImpl(java.lang.String functionName, ManagedFunctionFactory<O,F> functionFactory, java.lang.Object[] annotations, java.lang.Class<?> parameterType, TeamManagement responsibleTeam, ManagedObjectIndex[] functionIndexedManagedObjects, ManagedObjectMetaData<?>[] functionBoundManagedObjects, boolean[] requiredGovernance, long asynchronousFlowTimeout, AssetManager asynchronousFlowsAssetManager, java.util.logging.Logger logger, java.util.concurrent.Executor executor)

Initiate with details of the meta-data for the ManagedFunction.

Method Summary

Modifier and Type	Method	Description
java.lang.Object[]	getAnnotations()	Obtains the annotations for the ManagedFunction.
AssetManager	getAsynchronousFlowManager()	Obtains the AssetManager that manages AsynchronousFlow instances instigated by the ManagedFunction.
long	getAsynchronousFlowTimeout()	Obtains the time out for AsynchronousFlow instigated by the ManagedFunction.
EscalationProcedure	getEscalationProcedure()	Obtains the EscalationProcedure for the ManagedFunctionLogic.
java.util.concurrent.Executor	getExecutor()	Obtains the Executor for ManagedFunctionContext.
FlowMetaData	getFlow(int flowIndex)	Obtains the FlowMetaData of the specified Flow.
java.lang.String	getFunctionName()	Obtains the name of the ManagedFunctionLogic.
java.util.logging.Logger	getLogger()	Obtains the Logger for ManagedFunctionContext.
ManagedFunctionFactory<O,F>	getManagedFunctionFactory()	Obtains the ManagedFunctionFactory to create the ManagedFunction for this ManagedFunctionMetaData.
ManagedObjectIndex	getManagedObject(int managedObjectIndex)	Obtains the ManagedObjectIndex for the ManagedFunction index.
ManagedObjectMetaData<?>[]	getManagedObjectMetaData()	Obtains the meta-data of the ManagedObject instances bound to the ManagedFunction.
ManagedFunctionMetaData<?,?>	getNextManagedFunctionMetaData()	Obtains the ManagedFunctionMetaData of the next ManagedFunction.
OfficeMetaData	getOfficeMetaData()	Obtains the OfficeMetaData.
java.lang.Class<?>	getParameterType()	Obtains the parameter type for the ManagedFunction.
ManagedFunctionAdministrationMetaData<?,?,?>[]	getPostAdministrationMetaData()	Meta-data of the Administration to undertake after executing the ManagedFunction.
ManagedFunctionAdministrationMetaData<?,?,?>[]	getPreAdministrationMetaData()	Meta-data of the Administration to undertake before executing the ManagedFunction.
boolean[]	getRequiredGovernance()	Obtains the activation flags for the Governance.
ManagedObjectIndex[]	getRequiredManagedObjects()	Obtains the ManagedObjectIndex instances identifying the ManagedObject instances that must be loaded before the ManagedFunction may be executed.
TeamManagement	getResponsibleTeam()	Obtains the TeamManagement responsible for completion of the FunctionState.
void	loadOfficeMetaData(OfficeMetaData officeMetaData, FlowMetaData[] flowMetaData, ManagedFunctionMetaData<?,?> nextFunctionMetaData, EscalationProcedure escalationProcedure, ManagedFunctionAdministrationMetaData<?,?,?>[] preAdministration, ManagedFunctionAdministrationMetaData<?,?,?>[] postAdministration, ManagedObjectIndex[] requiredManagedObjects)	Loads the remaining state of this ManagedFunctionMetaData.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedFunctionMetaDataImpl

public ManagedFunctionMetaDataImpl(java.lang.String functionName,
                                   ManagedFunctionFactory<O,F> functionFactory,
                                   java.lang.Object[] annotations,
                                   java.lang.Class<?> parameterType,
                                   TeamManagement responsibleTeam,
                                   ManagedObjectIndex[] functionIndexedManagedObjects,
                                   ManagedObjectMetaData<?>[] functionBoundManagedObjects,
                                   boolean[] requiredGovernance,
                                   long asynchronousFlowTimeout,
                                   AssetManager asynchronousFlowsAssetManager,
                                   java.util.logging.Logger logger,
                                   java.util.concurrent.Executor executor)

Initiate with details of the meta-data for the ManagedFunction.

Parameters:

functionName - Name of the ManagedFunction.

functionFactory - ManagedFunctionFactory to create the ManagedFunction of the ManagedFunctionMetaData.

annotations - Differentiators.

parameterType - Parameter type of this ManagedFunction.

responsibleTeam - TeamManagement of the Team responsible for executing this ManagedFunction. May be null.

functionIndexedManagedObjects - Translates the ManagedFunction index to the ManagedObjectIndex to obtain the ManagedObject for the ManagedFunction.

functionBoundManagedObjects - ManagedObjectMetaData of the ManagedObject instances bound to the ManagedFunction.

requiredGovernance - Required Governance.

asynchronousFlowTimeout - AsynchronousFlow timeout.

asynchronousFlowsAssetManager - AssetManager for the invoked AsynchronousFlow instances.

logger - Logger for ManagedFunctionContext.

executor - Executor for ManagedFunctionContext.

Method Detail

loadOfficeMetaData

public void loadOfficeMetaData(OfficeMetaData officeMetaData,
                               FlowMetaData[] flowMetaData,
                               ManagedFunctionMetaData<?,?> nextFunctionMetaData,
                               EscalationProcedure escalationProcedure,
                               ManagedFunctionAdministrationMetaData<?,?,?>[] preAdministration,
                               ManagedFunctionAdministrationMetaData<?,?,?>[] postAdministration,
                               ManagedObjectIndex[] requiredManagedObjects)

Loads the remaining state of this ManagedFunctionMetaData.

Parameters:

officeMetaData - OfficeMetaData.

flowMetaData - Meta-data of the available Flow instances from this ManagedFunction.

nextFunctionMetaData - ManagedFunctionMetaData of the next ManagedFunction.

escalationProcedure - EscalationProcedure for exceptions of the ManagedFunction of this ManagedFunctionMetaData.

preAdministration - ManagedFunctionAdministrationMetaData specifying the Administration instances to be completed before executing the ManagedFunction.

postAdministration - ManagedFunctionAdministrationMetaData specifying the Administration instances to be completed after executing the ManagedFunction.

requiredManagedObjects - ManagedObjectIndex instances identifying the ManagedObject instances that must be loaded before the ManagedFunction may be executed.

getFunctionName

public java.lang.String getFunctionName()

Description copied from interface: ManagedFunctionLogicMetaData

Obtains the name of the ManagedFunctionLogic.

Specified by:

getFunctionName in interface ManagedFunctionLogicMetaData

Returns:

Name of the ManagedFunctionLogic.

getManagedFunctionFactory

public ManagedFunctionFactory<O,F> getManagedFunctionFactory()

Description copied from interface: ManagedFunctionMetaData

Obtains the ManagedFunctionFactory to create the ManagedFunction for this ManagedFunctionMetaData.

Specified by:

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

Returns:

ManagedFunctionFactory

getAnnotations

public java.lang.Object[] getAnnotations()

Description copied from interface: ManagedFunctionMetaData

Obtains the annotations for the ManagedFunction.

Specified by:

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

Returns:

Annotations.

getParameterType

public java.lang.Class<?> getParameterType()

Description copied from interface: ManagedFunctionMetaData

Obtains the parameter type for the ManagedFunction.

Specified by:

getParameterType in interface ManagedFunctionMetaData<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Parameter type for the ManagedFunction. May be null to indicate no parameter.

getLogger

public java.util.logging.Logger getLogger()

Description copied from interface: ManagedFunctionMetaData

Obtains the Logger for ManagedFunctionContext.

Specified by:

getLogger in interface ManagedFunctionMetaData<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Logger for ManagedFunctionContext.

getExecutor

public java.util.concurrent.Executor getExecutor()

Description copied from interface: ManagedFunctionMetaData

Obtains the Executor for ManagedFunctionContext.

Specified by:

getExecutor in interface ManagedFunctionMetaData<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Executor for ManagedFunctionContext.

getResponsibleTeam

public TeamManagement getResponsibleTeam()

Description copied from interface: ManagedFunctionLogicMetaData

Obtains the TeamManagement responsible for completion of the FunctionState.

Specified by:

getResponsibleTeam in interface ManagedFunctionLogicMetaData

Returns:

TeamManagement responsible for completion of the FunctionState. May be null to enable any Team to execute the FunctionState.

getRequiredManagedObjects

public ManagedObjectIndex[] getRequiredManagedObjects()

Description copied from interface: ManagedFunctionMetaData

Obtains the ManagedObjectIndex instances identifying the ManagedObject instances that must be loaded before the ManagedFunction may be executed.

The order of the ManagedObjectIndex instances must be respected as they are sorted to enable appropriate CoordinatingManagedObject to co-ordinate with dependencies.

Specified by:

getRequiredManagedObjects in interface ManagedFunctionMetaData<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Listing of ManagedObjectIndex instances.

getRequiredGovernance

public boolean[] getRequiredGovernance()

Description copied from interface: ManagedFunctionMetaData

Obtains the activation flags for the Governance. The index into the array identifies the Governance for the respective activation flag.

Specified by:

getRequiredGovernance in interface ManagedFunctionMetaData<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Activation flags for the Governance.

getManagedObject

public ManagedObjectIndex getManagedObject(int managedObjectIndex)

Description copied from interface: ManagedFunctionMetaData

Obtains the ManagedObjectIndex for the ManagedFunction index.

Specified by:

getManagedObject in interface ManagedFunctionMetaData<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Parameters:

managedObjectIndex - ManagedObjectIndex for the ManagedFunction index.

Returns:

ManagedObjectIndex to obtain the ManagedObject for the ManagedFunction.

getFlow

public FlowMetaData getFlow(int flowIndex)

Description copied from interface: ManagedFunctionLogicMetaData

Obtains the FlowMetaData of the specified Flow.

Specified by:

getFlow in interface ManagedFunctionLogicMetaData

Parameters:

flowIndex - Index of the Flow.

Returns:

FlowMetaData of the specified Flow.

getAsynchronousFlowTimeout

public long getAsynchronousFlowTimeout()

Description copied from interface: ManagedFunctionLogicMetaData

Obtains the time out for AsynchronousFlow instigated by the ManagedFunction.

Specified by:

getAsynchronousFlowTimeout in interface ManagedFunctionLogicMetaData

Returns:

Time out for AsynchronousFlow instigated by the ManagedFunction.

getAsynchronousFlowManager

public AssetManager getAsynchronousFlowManager()

Description copied from interface: ManagedFunctionLogicMetaData

Obtains the AssetManager that manages AsynchronousFlow instances instigated by the ManagedFunction.

Specified by:

getAsynchronousFlowManager in interface ManagedFunctionLogicMetaData

Returns:

AssetManager that manages AsynchronousFlow instances instigated by the ManagedFunction.

getEscalationProcedure

public EscalationProcedure getEscalationProcedure()

Description copied from interface: ManagedFunctionLogicMetaData

Obtains the EscalationProcedure for the ManagedFunctionLogic.

Specified by:

getEscalationProcedure in interface ManagedFunctionLogicMetaData

Returns:

EscalationProcedure.

getOfficeMetaData

public OfficeMetaData getOfficeMetaData()

Description copied from interface: ManagedFunctionLogicMetaData

Obtains the OfficeMetaData.

Specified by:

getOfficeMetaData in interface ManagedFunctionLogicMetaData

Returns:

OfficeMetaData.

getNextManagedFunctionMetaData

public ManagedFunctionMetaData<?,?> getNextManagedFunctionMetaData()

Description copied from interface: ManagedFunctionLogicMetaData

Obtains the ManagedFunctionMetaData of the next ManagedFunction.

Specified by:

getNextManagedFunctionMetaData in interface ManagedFunctionLogicMetaData

Returns:

ManagedFunctionMetaData of next ManagedFunction.

getPreAdministrationMetaData

public ManagedFunctionAdministrationMetaData<?,?,?>[] getPreAdministrationMetaData()

Description copied from interface: ManagedFunctionMetaData

Meta-data of the Administration to undertake before executing the ManagedFunction.

Specified by:

getPreAdministrationMetaData in interface ManagedFunctionMetaData<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Listing of the Administration instances to undertake before executing the ManagedFunction.

getPostAdministrationMetaData

public ManagedFunctionAdministrationMetaData<?,?,?>[] getPostAdministrationMetaData()

Description copied from interface: ManagedFunctionMetaData

Meta-data of the Administration to undertake after executing the ManagedFunction.

Specified by:

getPostAdministrationMetaData in interface ManagedFunctionMetaData<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Listing the Administration instances to undertake after executing the ManagedFunction.

getManagedObjectMetaData

public ManagedObjectMetaData<?>[] getManagedObjectMetaData()

Description copied from interface: ManagedFunctionMetaData

Obtains the meta-data of the ManagedObject instances bound to the ManagedFunction.

Specified by:

getManagedObjectMetaData in interface ManagedFunctionMetaData<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Returns:

Meta-data of the ManagedObject instances bound to the ManagedFunction.