net.officefloor.frame.spi.managedobject.source

Interface ManagedObjectSourceContext<F extends Enum<F>>

All Superinterfaces:

SourceContext, SourceProperties

All Known Implementing Classes:

ManagedObjectSourceContextImpl

public interface ManagedObjectSourceContext<F extends Enum<F>>
extends SourceContext

Context for a ManagedObjectSource.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
void	addStartupTask(String workName, String taskName) Adds a Task to invoke on start up of the Office.
<W extends Work> ManagedObjectWorkBuilder<W>	addWork(String workName, WorkFactory<W> workFactory) Adds ManagedObjectWorkBuilder for Work of the ManagedObjectSource.
<W extends Work> ManagedObjectWorkBuilder<W>	getRecycleWork(WorkFactory<W> workFactory) Invoking this method during the ManagedObjectSource.init(ManagedObjectSourceContext) will create recycle functionality for the ManagedObject to be returned to a ManagedObjectPool.
void	linkProcess(F key, String workName, String taskName) Links in a JobSequence by specifying the first Task of the JobSequence.
void	linkProcess(int flowIndex, String workName, String taskName) Links in a JobSequence by specifying the first Task of the JobSequence.

Methods inherited from interface net.officefloor.frame.spi.source.SourceContext

getClassLoader, getOptionalResource, getResource, isLoadingType, loadClass, loadOptionalClass

Methods inherited from interface net.officefloor.frame.spi.source.SourceProperties

getProperties, getProperty, getProperty, getPropertyNames

Method Detail

linkProcess

void linkProcess(F key,
                 String workName,
                 String taskName)

Links in a JobSequence by specifying the first Task of the JobSequence.

The Task must be registered by this ManagedObjectSource.

Parameters:

key - Key identifying JobSequence being invoked by the ManagedObjectSource.

workName - Name of the Work that the Task resides on.

taskName - Name of Task.

linkProcess

void linkProcess(int flowIndex,
                 String workName,
                 String taskName)

Links in a JobSequence by specifying the first Task of the JobSequence.

The Task must be registered by this ManagedObjectSource.

Parameters:

flowIndex - Index identifying the JobSequence.

workName - Name of the Work that the Task resides on.

taskName - Name of Task.

getRecycleWork

<W extends Work> ManagedObjectWorkBuilder<W> getRecycleWork(WorkFactory<W> workFactory)

Invoking this method during the ManagedObjectSource.init(ManagedObjectSourceContext) will create recycle functionality for the ManagedObject to be returned to a ManagedObjectPool.

The initial Task will be used as the recycle starting point for this ManagedObject.

Type Parameters:

W - Work type.

Parameters:

workFactory - WorkFactory to create the recycle Work.

Returns:

WorkBuilder to recycle this ManagedObject.

addWork

<W extends Work> ManagedObjectWorkBuilder<W> addWork(String workName,
                                                     WorkFactory<W> workFactory)

Adds ManagedObjectWorkBuilder for Work of the ManagedObjectSource.

Type Parameters:

W - Work type.

Parameters:

workName - Name of the Work.

workFactory - WorkFactory to create the Work.

Returns:

ManagedObjectWorkBuilder.

addStartupTask

void addStartupTask(String workName,
                    String taskName)

Adds a Task to invoke on start up of the Office.

The Task must be registered by this ManagedObjectSource.

Parameters:

workName - Name of Work containing the Task.

taskName - Name of Task on the Work.