Package net.officefloor.frame.impl.construct.function

Class AbstractFunctionBuilder<F extends java.lang.Enum<F>>

java.lang.Object

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

All Implemented Interfaces:

FunctionBuilder<F>, FunctionConfiguration<F>

Direct Known Subclasses:

AdministrationBuilderImpl, GovernanceBuilderImpl, ManagedFunctionBuilderImpl

public abstract class AbstractFunctionBuilder<F extends java.lang.Enum<F>>
extends java.lang.Object
implements FunctionBuilder<F>, FunctionConfiguration<F>

Abstract FunctionBuilder.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
AbstractFunctionBuilder()

Method Summary

Modifier and Type	Method	Description
void	addEscalation(java.lang.Class<? extends java.lang.Throwable> typeOfCause, java.lang.String functionName)	Adds an EscalationFlow to the EscalationProcedure for the ManagedFunction.
EscalationConfiguration[]	getEscalations()	Obtains the EscalationConfiguration instances.
FlowConfiguration<F>[]	getFlowConfiguration()	Obtains the configuration of the Flow instances for this ManagedFunctionLogic.
java.lang.String	getResponsibleTeamName()	Obtains the name of the Team to execute the ManagedFunctionLogic.
void	linkFlow(int flowIndex, java.lang.String functionName, java.lang.Class<?> argumentType, boolean isSpawnThreadState)	Links in a Flow by specifying the first ManagedFunction of the Flow.
void	linkFlow(F key, java.lang.String functionName, java.lang.Class<?> argumentType, boolean isSpawnThreadState)	Links in a Flow by specifying the first ManagedFunction of the Flow.
void	setResponsibleTeam(java.lang.String officeTeamName)	Specifies the Team by its Office registered name that that is responsible for this node.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFunctionBuilder

public AbstractFunctionBuilder()

Method Detail

setResponsibleTeam

public void setResponsibleTeam(java.lang.String officeTeamName)

Description copied from interface: FunctionBuilder

Specifies the Team by its Office registered name that that is responsible for this node.

Should this not be specified, any Team will be used.

Specified by:

setResponsibleTeam in interface FunctionBuilder<F extends java.lang.Enum<F>>

Parameters:

officeTeamName - Name of the Team within the Office.

linkFlow

public void linkFlow(F key,
                     java.lang.String functionName,
                     java.lang.Class<?> argumentType,
                     boolean isSpawnThreadState)

Description copied from interface: FunctionBuilder

Links in a Flow by specifying the first ManagedFunction of the Flow.

Specified by:

linkFlow in interface FunctionBuilder<F extends java.lang.Enum<F>>

Parameters:

key - Key identifying the Flow.

functionName - Name of the initial ManagedFunction for the Flow.

argumentType - Type of argument passed to the instigated Flow. May be null to indicate no argument.

isSpawnThreadState - true to instigate the Flow in a spawned ThreadState.

linkFlow

public void linkFlow(int flowIndex,
                     java.lang.String functionName,
                     java.lang.Class<?> argumentType,
                     boolean isSpawnThreadState)

Description copied from interface: FunctionBuilder

Links in a Flow by specifying the first ManagedFunction of the Flow.

Specified by:

linkFlow in interface FunctionBuilder<F extends java.lang.Enum<F>>

Parameters:

flowIndex - Index identifying the Flow.

functionName - Name of the initial ManagedFunction for the Flow.

argumentType - Type of argument passed to the instigated Flow. May be null to indicate no argument.

isSpawnThreadState - true to instigate the Flow in a spawned ThreadState.

addEscalation

public void addEscalation(java.lang.Class<? extends java.lang.Throwable> typeOfCause,
                          java.lang.String functionName)

Description copied from interface: FunctionBuilder

Adds an EscalationFlow to the EscalationProcedure for the ManagedFunction.

The order in which the EscalationFlow instances are added is the order in which they are checked for handling escalation. Only one EscalationFlow is used to handle escalation and the first one covering the cause will be used. This is similar to try ... catch blocks.

Specified by:

addEscalation in interface FunctionBuilder<F extends java.lang.Enum<F>>

Parameters:

typeOfCause - Type of cause handled by this EscalationFlow.

functionName - Name of the ManagedFunction to handle the Escalation.

getResponsibleTeamName

public java.lang.String getResponsibleTeamName()

Description copied from interface: FunctionConfiguration

Obtains the name of the Team to execute the ManagedFunctionLogic.

Specified by:

getResponsibleTeamName in interface FunctionConfiguration<F extends java.lang.Enum<F>>

Returns:

Name of Team. May be null to use any Team.

getFlowConfiguration

public FlowConfiguration<F>[] getFlowConfiguration()

Description copied from interface: FunctionConfiguration

Obtains the configuration of the Flow instances for this ManagedFunctionLogic.

Specified by:

getFlowConfiguration in interface FunctionConfiguration<F extends java.lang.Enum<F>>

Returns:

Configuration of Flow instances for this ManagedFunctionLogic.

getEscalations

public EscalationConfiguration[] getEscalations()

Description copied from interface: FunctionConfiguration

Obtains the EscalationConfiguration instances.

Specified by:

getEscalations in interface FunctionConfiguration<F extends java.lang.Enum<F>>

Returns:

EscalationConfiguration instances.