net.officefloor.frame.api.build

Interface WorkBuilder<W extends Work>

All Known Implementing Classes:

WorkBuilderImpl

public interface WorkBuilder<W extends Work>

Builder of the Work.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
<D extends Enum<D>,F extends Enum<F>> TaskBuilder<W,D,F>	addTask(String taskName, TaskFactory<? super W,D,F> taskFactory) Creates the TaskBuilder to build a Task for this Work.
<I,A extends Enum<A>,AS extends AdministratorSource<I,A>> AdministratorBuilder<A>	addWorkAdministrator(String workAdministratorName, Class<AS> adminsistratorSource) Adds a Work bound Administrator.
DependencyMappingBuilder	addWorkManagedObject(String workManagedObjectName, String officeManagedObjectName) Adds a Work bound ManagedObject.
void	setInitialTask(String initialTaskName) Specifies the initial Task of the Work.

Method Detail

addWorkManagedObject

DependencyMappingBuilder addWorkManagedObject(String workManagedObjectName,
                                              String officeManagedObjectName)

Adds a Work bound ManagedObject.

Dependency scope:

1. Other ManagedObject instances added via this method.
2. ProcessState bound ManagedObject instances linked to this Work.

Parameters:

workManagedObjectName - Name of the ManagedObject to be referenced locally by this Work.

officeManagedObjectName - Name of the ManagedObject referenced locally within the Office.

Returns:

DependencyMappingBuilder.

addWorkAdministrator

<I,A extends Enum<A>,AS extends AdministratorSource<I,A>> AdministratorBuilder<A> addWorkAdministrator(String workAdministratorName,
                                                                                                       Class<AS> adminsistratorSource)

Adds a Work bound Administrator.

Type Parameters:

I - Extension interface type.

A - Administrator type.

AS - AdministratorSource type.

Parameters:

workAdministratorName - Name of the Administrator to be referenced locally by this Work.

adminsistratorSource - AdministratorSource class.

Returns:

AdministratorBuilder for the Administrator.

setInitialTask

void setInitialTask(String initialTaskName)

Specifies the initial Task of the Work.

Parameters:

initialTaskName - Initial Task.

addTask

<D extends Enum<D>,F extends Enum<F>> TaskBuilder<W,D,F> addTask(String taskName,
                                                                 TaskFactory<? super W,D,F> taskFactory)

Creates the TaskBuilder to build a Task for this Work.

Type Parameters:

D - Dependency key type.

F - Flow key type.

Parameters:

taskName - Name of task local to this Work.

taskFactory - TaskFactory to create the Task.

Returns:

TaskBuilder for the Task.