Package net.officefloor.frame.internal.structure

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

All Superinterfaces:

ManagedFunctionLogicMetaData

All Known Implementing Classes:

ManagedFunctionMetaDataImpl

public interface ManagedFunctionMetaData<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>
extends ManagedFunctionLogicMetaData

Meta-data for the ManagedFunction.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
java.lang.Object[]	getAnnotations()	Obtains the annotations for the ManagedFunction.
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.
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.

Methods inherited from interface net.officefloor.frame.internal.structure.ManagedFunctionLogicMetaData

getAsynchronousFlowManagerReference, getAsynchronousFlowTimeout, getEscalationProcedure, getFlow, getFunctionName, getNextManagedFunctionMetaData, getOfficeMetaData, getResponsibleTeam

Method Detail

getManagedFunctionFactory

ManagedFunctionFactory<O,F> getManagedFunctionFactory()

Obtains the ManagedFunctionFactory to create the ManagedFunction for this ManagedFunctionMetaData.

Returns:

ManagedFunctionFactory

getAnnotations

java.lang.Object[] getAnnotations()

Obtains the annotations for the ManagedFunction.

Returns:

Annotations.

getParameterType

java.lang.Class<?> getParameterType()

Obtains the parameter type for the ManagedFunction.

Returns:

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

getLogger

java.util.logging.Logger getLogger()

Obtains the Logger for ManagedFunctionContext.

Returns:

Logger for ManagedFunctionContext.

getRequiredManagedObjects

ManagedObjectIndex[] getRequiredManagedObjects()

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.

Returns:

Listing of ManagedObjectIndex instances.

getRequiredGovernance

boolean[] getRequiredGovernance()

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

Returns:

Activation flags for the Governance.

getManagedObject

ManagedObjectIndex getManagedObject(int managedObjectIndex)

Obtains the ManagedObjectIndex for the ManagedFunction index.

Parameters:

managedObjectIndex - ManagedObjectIndex for the ManagedFunction index.

Returns:

ManagedObjectIndex to obtain the ManagedObject for the ManagedFunction.

getManagedObjectMetaData

ManagedObjectMetaData<?>[] getManagedObjectMetaData()

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

Returns:

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

getPreAdministrationMetaData

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

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

Returns:

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

getPostAdministrationMetaData

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

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

Returns:

Listing the Administration instances to undertake after executing the ManagedFunction.