net.officefloor.frame.internal.structure

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

All Superinterfaces:

JobMetaData

All Known Implementing Classes:

TaskMetaDataImpl

public interface TaskMetaData<W extends Work,D extends Enum<D>,F extends Enum<F>>
extends JobMetaData

Meta-data for the Task.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
JobNode	createTaskNode(JobSequence flow, WorkContainer<W> workContainer, JobNode parallelJobNodeOwner, Object parameter, GovernanceDeactivationStrategy governanceDeactivationStrategy) Creates the JobNode for the Task.
Object	getDifferentiator() Obtains the differentiator for the Task.
FlowMetaData<?>	getFlow(int flowIndex) Obtains the FlowMetaData of the specified JobSequence.
Class<?>	getParameterType() Obtains the parameter type for the Task.
TaskDutyAssociation<?>[]	getPostAdministrationMetaData() Meta-data of the Administrator to undertake after executing the Task.
TaskDutyAssociation<?>[]	getPreAdministrationMetaData() Meta-data of the Duty to undertake before executing the Task.
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 Task may be executed.
TaskFactory<W,D,F>	getTaskFactory() Obtains the TaskFactory to create the Task for this TaskMetaData.
String	getTaskName() Obtains the name of this Task.
WorkMetaData<W>	getWorkMetaData() Obtains the WorkMetaData for this Task.
ManagedObjectIndex	translateManagedObjectIndexForWork(int taskMoIndex) Translates the ManagedObject index of the Task to that of the Work (ManagedObjectIndex).

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

createJobActivableSet, getContinueTeam, getEscalationProcedure, getJobName, getNextTaskInFlow, getResponsibleTeam

Method Detail

getTaskName

String getTaskName()

Obtains the name of this Task.

Returns:

Name of this Task.

getTaskFactory

TaskFactory<W,D,F> getTaskFactory()

Obtains the TaskFactory to create the Task for this TaskMetaData.

Returns:

TaskFactory

getDifferentiator

Object getDifferentiator()

Obtains the differentiator for the Task.

Returns:

Differentiator or null if no differentiator.

getParameterType

Class<?> getParameterType()

Obtains the parameter type for the Task.

Returns:

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

getRequiredManagedObjects

ManagedObjectIndex[] getRequiredManagedObjects()

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

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.

translateManagedObjectIndexForWork

ManagedObjectIndex translateManagedObjectIndexForWork(int taskMoIndex)

Translates the ManagedObject index of the Task to that of the Work (ManagedObjectIndex).

Parameters:

taskMoIndex - ManagedObject index of the Task.

Returns:

ManagedObjectIndex identifying the ManagedObject for the Task index.

getFlow

FlowMetaData<?> getFlow(int flowIndex)

Obtains the FlowMetaData of the specified JobSequence.

Parameters:

flowIndex - Index of the JobSequence.

Returns:

FlowMetaData of the specified JobSequence.

getWorkMetaData

WorkMetaData<W> getWorkMetaData()

Obtains the WorkMetaData for this Task.

Returns:

WorkMetaData for this Task.

getPreAdministrationMetaData

TaskDutyAssociation<?>[] getPreAdministrationMetaData()

Meta-data of the Duty to undertake before executing the Task.

Returns:

Listing of the Duty instances to undertake before executing the Task.

getPostAdministrationMetaData

TaskDutyAssociation<?>[] getPostAdministrationMetaData()

Meta-data of the Administrator to undertake after executing the Task.

Returns:

Listing the Duty instances to undertake after executing the Task.

createTaskNode

JobNode createTaskNode(JobSequence flow,
                       WorkContainer<W> workContainer,
                       JobNode parallelJobNodeOwner,
                       Object parameter,
                       GovernanceDeactivationStrategy governanceDeactivationStrategy)

Creates the JobNode for the Task.

Parameters:

flow - JobSequence containing the Task.

workContainer - WorkContainer for the Work for the Task.

parallelJobNodeOwner - Parallel JobNode owner.

parameter - Parameter.

governanceDeactivationStrategy - GovernanceDeactivationStrategy.

Returns:

JobNode.