de.zib.gndms.logic.model.gorfx.taskflow.TaskFlowFactory< O extends Order, C extends AbstractQuoteCalculator< O > > Interface Reference

An interface for taskflow factories. More...

List of all members.

Public Member Functions
int	getVersion ()
	Delivers the version of the plugin.
C	getQuoteCalculator ()
	Delivers a calculator for quotes of the taskflow.
TaskFlowInfo	getInfo ()
	Delivers information about the taskflow in general.
TaskFlow< O >	create ()
	Creates a new taskflow instance.
TaskFlow< O >	createOrphan ()
	Creates a new taskflow instance.
boolean	adopt (TaskFlow< O > taskflow)
	Adds an orphan task flow to the facotry.
TaskFlow< O >	find (String id)
	Finds an existing taskflow.
void	delete (String id)
	Removes a taskflow.
Class< O >	getOrderClass ()
	Delivers the class of the order type.
TaskAction	createAction ()
	Creates a task action.
Iterable< String >	depends ()
	Delivers a list of keys of taskflows, this taskflow depends on.
void	registerType (Session session)
	Registers the TaskFlowType object of this factory.
DelegatingOrder< O >	getOrderDelegate (O orq)
void	setInjector (GNDMSInjector injector)
	Addes an injector to a task factory.
Package Functions
String	getTaskFlowKey ()
	Delivers the key of this task flow.

---

Detailed Description

An interface for taskflow factories.

Author:

try ma ik jo rr a zib

Date:

14.02.11 14:27 Implementations of this interface should be able to compute quotes, and generate task instances.

---

Member Function Documentation

boolean de.zib.gndms.logic.model.gorfx.taskflow.TaskFlowFactory< O extends Order, C extends AbstractQuoteCalculator< O > >.adopt

(

TaskFlow< O >

taskflow

)

Adds an orphan task flow to the facotry.

Parameters:

taskflow

The taskflow to add. Note the taskflow must have a unique id.

Returns:

true if the taskflow was successfully added. If the task is already registered this will fail.

TaskFlow<O> de.zib.gndms.logic.model.gorfx.taskflow.TaskFlowFactory< O extends Order, C extends AbstractQuoteCalculator< O > >.create

(

)

Creates a new taskflow instance.

The created task is registered in its factory.

Returns:

A taskflow object.

TaskAction de.zib.gndms.logic.model.gorfx.taskflow.TaskFlowFactory< O extends Order, C extends AbstractQuoteCalculator< O > >.createAction

(

)

Creates a task action.

Returns:

The newly created action.

TaskFlow<O> de.zib.gndms.logic.model.gorfx.taskflow.TaskFlowFactory< O extends Order, C extends AbstractQuoteCalculator< O > >.createOrphan

(

)

Creates a new taskflow instance.

The created task flow is registered in its factory.

Returns:

A taskflow object.

void de.zib.gndms.logic.model.gorfx.taskflow.TaskFlowFactory< O extends Order, C extends AbstractQuoteCalculator< O > >.delete

(

String

id

)

Removes a taskflow.

Parameters:

id	The id of the taskflow.

Iterable<String> de.zib.gndms.logic.model.gorfx.taskflow.TaskFlowFactory< O extends Order, C extends AbstractQuoteCalculator< O > >.depends

(

)

Delivers a list of keys of taskflows, this taskflow depends on.

Returns:

A list of taskflow keys or an empty list if it has no dependencies. Note it must not return null.

TaskFlow<O> de.zib.gndms.logic.model.gorfx.taskflow.TaskFlowFactory< O extends Order, C extends AbstractQuoteCalculator< O > >.find

(

String

id

)

Finds an existing taskflow.

Parameters:

id	The id of the taskflow.

Returns:

The taskflow or null if it doesn't exist.

TaskFlowInfo de.zib.gndms.logic.model.gorfx.taskflow.TaskFlowFactory< O extends Order, C extends AbstractQuoteCalculator< O > >.getInfo

(

)

Delivers information about the taskflow in general.

The information should contain at least a description of the task.

Returns:

A task info object.

Class<O> de.zib.gndms.logic.model.gorfx.taskflow.TaskFlowFactory< O extends Order, C extends AbstractQuoteCalculator< O > >.getOrderClass

(

)

Delivers the class of the order type.

Returns:

The class of the taskflows order type.

C de.zib.gndms.logic.model.gorfx.taskflow.TaskFlowFactory< O extends Order, C extends AbstractQuoteCalculator< O > >.getQuoteCalculator

(

)

Delivers a calculator for quotes of the taskflow.

Returns:

A quote calculator.

String de.zib.gndms.logic.model.gorfx.taskflow.TaskFlowFactory< O extends Order, C extends AbstractQuoteCalculator< O > >.getTaskFlowKey

(

)

[package]

Delivers the key of this task flow.

Returns:

The taskflow key.

int de.zib.gndms.logic.model.gorfx.taskflow.TaskFlowFactory< O extends Order, C extends AbstractQuoteCalculator< O > >.getVersion

(

)

Delivers the version of the plugin.

Returns:

An integer representing the version.

void de.zib.gndms.logic.model.gorfx.taskflow.TaskFlowFactory< O extends Order, C extends AbstractQuoteCalculator< O > >.registerType

(

Session

session

)

Registers the TaskFlowType object of this factory.

The TaskFlowType object is used to provide a configuration of the TaskFlow.

Parameters:

session

The session object which is necessary to access the database.

void de.zib.gndms.logic.model.gorfx.taskflow.TaskFlowFactory< O extends Order, C extends AbstractQuoteCalculator< O > >.setInjector

(

GNDMSInjector

injector

)

Addes an injector to a task factory.

Parameters:

injector

An injector which offers access to all members of the system-dictionary.

---

The documentation for this interface was generated from the following file:

• logic/src/de/zib/gndms/logic/model/gorfx/taskflow/TaskFlowFactory.java