net.officefloor.frame.impl.construct.work

Class WorkBuilderImpl<W extends Work>

java.lang.Object

net.officefloor.frame.impl.construct.work.WorkBuilderImpl<W>

All Implemented Interfaces:

WorkBuilder<W>, WorkConfiguration<W>

public class WorkBuilderImpl<W extends Work>
extends Object
implements WorkBuilder<W>, WorkConfiguration<W>

WorkBuilder implementation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
WorkBuilderImpl(String workName, WorkFactory<W> workFactory) Initiate.

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.
AdministratorSourceConfiguration<?,?>[]	getAdministratorConfiguration() Obtains the configuration of the Work bound Administrator instances.
String	getInitialTaskName() Obtains the name of the initial Task of the Work.
ManagedObjectConfiguration<?>[]	getManagedObjectConfiguration() Obtains the configuration of the Work bound ManagedObject instances.
TaskBuilder<W,?,?>	getTaskBuilder(String namespace, String taskName) Obtains the TaskBuilder.
<D extends Enum<D>,F extends Enum<F>> TaskConfiguration<W,D,F>[]	getTaskConfiguration() Obtains the configuration for the Task instances for the Work.
WorkFactory<W>	getWorkFactory() Obtains the WorkFactory to create the Work.
String	getWorkName() Obtains the name of this Work.
void	setInitialTask(String initialTaskName) Specifies the initial Task of the Work.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkBuilderImpl

public WorkBuilderImpl(String workName,
                       WorkFactory<W> workFactory)

Initiate.

Parameters:

workName - Name of the Work.

workFactory - WorkFactory.

Method Detail

getTaskBuilder

public TaskBuilder<W,?,?> getTaskBuilder(String namespace,
                                         String taskName)

Obtains the TaskBuilder.

Parameters:

namespace - Name space to identify the TaskBuilder.

taskName - Name of the TaskBuilder.

Returns:

TaskBuilder.

addWorkManagedObject

public DependencyMappingBuilder addWorkManagedObject(String workManagedObjectName,
                                                     String officeManagedObjectName)

Description copied from interface: WorkBuilder

Adds a Work bound ManagedObject.

Dependency scope:

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

Specified by:

addWorkManagedObject in interface WorkBuilder<W extends 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

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

Description copied from interface: WorkBuilder

Adds a Work bound Administrator.

Specified by:

addWorkAdministrator in interface WorkBuilder<W extends Work>

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

public void setInitialTask(String initialTaskName)

Description copied from interface: WorkBuilder

Specifies the initial Task of the Work.

Specified by:

setInitialTask in interface WorkBuilder<W extends Work>

Parameters:

initialTaskName - Initial Task.

addTask

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

Description copied from interface: WorkBuilder

Creates the TaskBuilder to build a Task for this Work.

Specified by:

addTask in interface WorkBuilder<W extends 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.

getWorkName

public String getWorkName()

Description copied from interface: WorkConfiguration

Obtains the name of this Work.

Specified by:

getWorkName in interface WorkConfiguration<W extends Work>

Returns:

Name of this Work.

getWorkFactory

public WorkFactory<W> getWorkFactory()

Description copied from interface: WorkConfiguration

Obtains the WorkFactory to create the Work.

Specified by:

getWorkFactory in interface WorkConfiguration<W extends Work>

Returns:

WorkFactory to create the Work to be done.

getManagedObjectConfiguration

public ManagedObjectConfiguration<?>[] getManagedObjectConfiguration()

Description copied from interface: WorkConfiguration

Obtains the configuration of the Work bound ManagedObject instances.

Specified by:

getManagedObjectConfiguration in interface WorkConfiguration<W extends Work>

Returns:

Listing of the ManagedObject configuration for this Work.

getAdministratorConfiguration

public AdministratorSourceConfiguration<?,?>[] getAdministratorConfiguration()

Description copied from interface: WorkConfiguration

Obtains the configuration of the Work bound Administrator instances.

Specified by:

getAdministratorConfiguration in interface WorkConfiguration<W extends Work>

Returns:

Listing of Administrator configuration this Work.

getInitialTaskName

public String getInitialTaskName()

Description copied from interface: WorkConfiguration

Obtains the name of the initial Task of the Work.

Specified by:

getInitialTaskName in interface WorkConfiguration<W extends Work>

Returns:

Name of the initial Task of the Work.

getTaskConfiguration

public <D extends Enum<D>,F extends Enum<F>> TaskConfiguration<W,D,F>[] getTaskConfiguration()

Description copied from interface: WorkConfiguration

Obtains the configuration for the Task instances for the Work.

Specified by:

getTaskConfiguration in interface WorkConfiguration<W extends Work>

Type Parameters:

D - Dependency key type.

F - Flow key type.

Returns:

Configuration for the Task instances of the Work.