Package net.officefloor.compile.managedfunction

Interface ManagedFunctionType<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>

All Superinterfaces:

AnnotatedType

All Known Implementing Classes:

ManagedFunctionTypeImpl

public interface ManagedFunctionType<M extends java.lang.Enum<M>,F extends java.lang.Enum<F>>
extends AnnotatedType

Type definition of a ManagedFunction.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
ManagedFunctionEscalationType[]	getEscalationTypes()	Obtains the ManagedFunctionEscalationType definitions for the possible EscalationFlow instances by the ManagedFunction.
java.lang.Class<F>	getFlowKeyClass()	Obtains the Enum providing the keys for the Flow instances instigated by the ManagedFunction.
ManagedFunctionFlowType<F>[]	getFlowTypes()	Obtains the ManagedFunctionFlowType definitions for the possible Flow instances instigated by the ManagedFunction.
java.lang.String	getFunctionName()	Obtains the name of the ManagedFunction.
ManagedFunctionFactory<M,F>	getManagedFunctionFactory()	Obtains the ManagedFunctionFactory.
java.lang.Class<M>	getObjectKeyClass()	Obtains the Enum providing the keys for the dependent Object instances.
ManagedFunctionObjectType<M>[]	getObjectTypes()	Obtains the ManagedFunctionObjectType definitions for the dependent Object instances required by the ManagedFunction.
java.lang.Class<?>	getReturnType()	Obtains the type name of Object returned from the ManagedFunction that is to be used as the argument to the next ManagedFunction.

Methods inherited from interface net.officefloor.compile.type.AnnotatedType

getAnnotation, getAnnotations, getAnnotations

Method Detail

getFunctionName

java.lang.String getFunctionName()

Obtains the name of the ManagedFunction.

Returns:

Name of the ManagedFunction.

getManagedFunctionFactory

ManagedFunctionFactory<M,F> getManagedFunctionFactory()

Obtains the ManagedFunctionFactory.

Returns:

ManagedFunctionFactory.

getReturnType

java.lang.Class<?> getReturnType()

Obtains the type name of Object returned from the ManagedFunction that is to be used as the argument to the next ManagedFunction.

Returns:

Return type name of the ManagedFunction.

getObjectKeyClass

java.lang.Class<M> getObjectKeyClass()

Obtains the Enum providing the keys for the dependent Object instances.

Returns:

Enum providing the dependent Object keys or null if Indexed or no dependencies.

getObjectTypes

ManagedFunctionObjectType<M>[] getObjectTypes()

Obtains the ManagedFunctionObjectType definitions for the dependent Object instances required by the ManagedFunction.

Returns:

ManagedFunctionObjectType definitions for the dependent Object instances required by the ManagedFunction.

getFlowKeyClass

java.lang.Class<F> getFlowKeyClass()

Obtains the Enum providing the keys for the Flow instances instigated by the ManagedFunction.

Returns:

Enum providing instigated Flow keys or null if Indexed or no instigated Flow instances.

getFlowTypes

ManagedFunctionFlowType<F>[] getFlowTypes()

Obtains the ManagedFunctionFlowType definitions for the possible Flow instances instigated by the ManagedFunction.

Returns:

ManagedFunctionFlowType definitions for the possible Flow instances instigated by the ManagedFunction.

getEscalationTypes

ManagedFunctionEscalationType[] getEscalationTypes()

Obtains the ManagedFunctionEscalationType definitions for the possible EscalationFlow instances by the ManagedFunction.

Returns:

ManagedFunctionEscalationType definitions for the possible EscalationFlow instances by the ManagedFunction.