net.officefloor.frame.api.build

Interface TaskBuilder<W extends Work,D extends Enum<D>,F extends Enum<F>>

All Superinterfaces:

FlowNodeBuilder<F>

All Known Implementing Classes:

TaskBuilderImpl

public interface TaskBuilder<W extends Work,D extends Enum<D>,F extends Enum<F>>
extends FlowNodeBuilder<F>

Builder of the Task.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
void	addGovernance(String governanceName) Adds OfficeFloor managed Governance to this Task.
void	linkManagedObject(D key, String scopeManagedObjectName, Class<?> objectType) Links in a ManagedObject to this Task.
void	linkManagedObject(int managedObjectIndex, String scopeManagedObjectName, Class<?> objectType) Links in a ManagedObject to this Task.
void	linkParameter(D key, Class<?> parameterType) Links in the parameter for this Task.
void	linkParameter(int index, Class<?> parameterType) Links in the parameter for this Task.
<A extends Enum<A>> void	linkPostTaskAdministration(String scopeAdministratorName, A dutyKey) Links in a Duty to be executed after the Task.
void	linkPostTaskAdministration(String scopeAdministratorName, String dutyName) Links in a Duty to be executed after the Task.
<A extends Enum<A>> void	linkPreTaskAdministration(String scopeAdministratorName, A dutyKey) Links in a Duty to be executed before the Task.
void	linkPreTaskAdministration(String scopeAdministratorName, String dutyName) Links in a Duty to be executed before the Task.
void	setDifferentiator(Object differentiator) Specifies the differentiator for this Task.

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

addEscalation, addEscalation, linkFlow, linkFlow, linkFlow, linkFlow, setNextTaskInFlow, setNextTaskInFlow, setTeam

Method Detail

setDifferentiator

void setDifferentiator(Object differentiator)

Specifies the differentiator for this Task.

This is exposed as is on the TaskManager interface for this Task to allow reflective:

1. identification of this Task (e.g. can check on type of this object)
2. means to trigger functionality on this Task (e.g. can expose functionality to be invoked)

Parameters:

differentiator - Differentiator.

linkParameter

void linkParameter(D key,
                   Class<?> parameterType)

Links in the parameter for this Task.

Parameters:

key - Key identifying the parameter.

parameterType - Type of the parameter.

linkParameter

void linkParameter(int index,
                   Class<?> parameterType)

Links in the parameter for this Task.

Parameters:

index - Index identifying the parameter.

parameterType - Type of the parameter.

linkManagedObject

void linkManagedObject(D key,
                       String scopeManagedObjectName,
                       Class<?> objectType)

Links in a ManagedObject to this Task.

Parameters:

key - Key identifying the ManagedObject.

scopeManagedObjectName - Name of the ManagedObject within the ManagedObjectScope.

objectType - Type required by the Task.

linkManagedObject

void linkManagedObject(int managedObjectIndex,
                       String scopeManagedObjectName,
                       Class<?> objectType)

Links in a ManagedObject to this Task.

Parameters:

managedObjectIndex - Index of the ManagedObject.

scopeManagedObjectName - Name of the ManagedObject within the ManagedObjectScope.

objectType - Type required by the Task.

linkPreTaskAdministration

<A extends Enum<A>> void linkPreTaskAdministration(String scopeAdministratorName,
                                                   A dutyKey)

Links in a Duty to be executed before the Task.

Type Parameters:

A - Administrator key type.

Parameters:

scopeAdministratorName - Name of the Administrator within the AdministratorScope.

dutyKey - Key identifying the Duty.

linkPreTaskAdministration

void linkPreTaskAdministration(String scopeAdministratorName,
                               String dutyName)

Links in a Duty to be executed before the Task.

Parameters:

scopeAdministratorName - Name of the Administrator within the AdministratorScope.

dutyName - Name identifying the Duty (as per AdministratorDutyMetaData).

linkPostTaskAdministration

<A extends Enum<A>> void linkPostTaskAdministration(String scopeAdministratorName,
                                                    A dutyKey)

Links in a Duty to be executed after the Task.

Type Parameters:

A - Administrator key type.

Parameters:

scopeAdministratorName - Name of the Administrator within the AdministratorScope.

dutyKey - Key identifying the Duty.

linkPostTaskAdministration

void linkPostTaskAdministration(String scopeAdministratorName,
                                String dutyName)

Links in a Duty to be executed after the Task.

Parameters:

scopeAdministratorName - Name of the Administrator within the AdministratorScope.

dutyName - Name identifying the Duty (as per AdministratorDutyMetaData).

addGovernance

void addGovernance(String governanceName)

Adds OfficeFloor managed Governance to this Task.

In other words, to execute this Task the Governance will be automatically activated before the Task is executed (or stay active from previous Task).

The Governance will be:

1. enforced when either a Task in the flow does not require the Governance or the ThreadState completes.
3. disregarded when an escalation occurs to a Task not requiring the Governance. Note that this does allow Governance to stay active should the Escalation Task require the Governance.

Parameters:

governanceName - Name of the Governance.