net.officefloor.compile.work

Interface TaskType<W extends Work,M extends Enum<M>,F extends Enum<F>>

All Known Implementing Classes:

TaskTypeImpl

public interface TaskType<W extends Work,M extends Enum<M>,F extends Enum<F>>

Type definition of a Task.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
Object	getDifferentiator() Obtains the differentiator.
TaskEscalationType[]	getEscalationTypes() Obtains the TaskEscalationType definitions for the possible EscalationFlow instances by the Task.
Class<F>	getFlowKeyClass() Obtains the Enum providing the keys for the JobSequence instances instigated by the Task.
TaskFlowType<F>[]	getFlowTypes() Obtains the TaskFlowType definitions for the possible JobSequence instances instigated by the Task.
Class<M>	getObjectKeyClass() Obtains the Enum providing the keys for the dependent Object instances.
TaskObjectType<M>[]	getObjectTypes() Obtains the TaskObjectType definitions for the dependent Object instances required by the Task.
Class<?>	getReturnType() Obtains the type of Object returned from the Task that is to be used as the argument to the next Task.
TaskFactory<W,M,F>	getTaskFactory() Obtains the TaskFactory.
String	getTaskName() Obtains the name of the Task.

Method Detail

getTaskName

String getTaskName()

Obtains the name of the Task.

Returns:

Name of the Task.

getTaskFactory

TaskFactory<W,M,F> getTaskFactory()

Obtains the TaskFactory.

Returns:

TaskFactory.

getDifferentiator

Object getDifferentiator()

Obtains the differentiator.

Returns:

Differentiator.

See Also:

TaskBuilder.setDifferentiator(Object)

getReturnType

Class<?> getReturnType()

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

Returns:

Return type of the Task.

getObjectKeyClass

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

TaskObjectType<M>[] getObjectTypes()

Obtains the TaskObjectType definitions for the dependent Object instances required by the Task.

Returns:

TaskObjectType definitions for the dependent Object instances required by the Task.

getFlowKeyClass

Class<F> getFlowKeyClass()

Obtains the Enum providing the keys for the JobSequence instances instigated by the Task.

Returns:

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

getFlowTypes

TaskFlowType<F>[] getFlowTypes()

Obtains the TaskFlowType definitions for the possible JobSequence instances instigated by the Task.

Returns:

TaskFlowType definitions for the possible JobSequence instances instigated by the Task.

getEscalationTypes

TaskEscalationType[] getEscalationTypes()

Obtains the TaskEscalationType definitions for the possible EscalationFlow instances by the Task.

Returns:

TaskEscalationType definitions for the possible EscalationFlow instances by the Task.