de.zib.gndms.common.GORFX.service.GORFXServiceEssentials Interface Reference

This is the essential interface of the GORFX service. Since its the services responsibility to create and manage complex tasks ( hence called taskflows ) this interface only provides methods necessary for this job. More...

Inheritance diagram for de.zib.gndms.common.GORFX.service.GORFXServiceEssentials:

List of all members.

Public Member Functions
ResponseEntity< List< String > >	listTaskFlows (String dn)
	Delivers a list of all supported taskflows.
ResponseEntity< TaskFlowInfo >	getTaskFlowInfo (String type, String dn)
	Get information about a specific taskflow.
ResponseEntity< Specifier < Facets > >	createTaskFlow (String type, Order order, String dn, String wid, MultiValueMap< String, String > context)
	Instantiates a taskflow.
Package Functions
ResponseEntity< Facets >	listAvailableFacets (String dn)
	Lists all facets of the service.

---

Detailed Description

This is the essential interface of the GORFX service. Since its the services responsibility to create and manage complex tasks ( hence called taskflows ) this interface only provides methods necessary for this job.

Author:

try ma ik jo rr a zib Date: 09.02.11, Time: 11:35

The interface should be implemented by clients which aren't required to perform tasks like system configuration and maintenance.

Some general remarks on the parameters:

• The dn parameter is a identifier for the user responsible for the method invocation. It is required to check if the user has the necessary permissions for the call.
  Using REST the attribute should be provided using a http-header property called "DN".
• wid stands for Workflow-ID and is used to associate calls to a single workflow mainly for logging and debugging.
  Using REST the attribute should be provided using a http-header property "wid".

---

Member Function Documentation

ResponseEntity<Specifier<Facets> > de.zib.gndms.common.GORFX.service.GORFXServiceEssentials.createTaskFlow	(	String	type,
		Order	order,
		String	dn,
		String	wid,
		MultiValueMap< String, String >	context
	)

Instantiates a taskflow.

Parameters:

type	Type name of the taskflow.
order	The order consists parameters for the taskflow.
dn	The dn of the user invoking the method.
wid	The workflow id.
context

Returns:

The specifier of the newly created task, with HTTPStatus created.

ResponseEntity<TaskFlowInfo> de.zib.gndms.common.GORFX.service.GORFXServiceEssentials.getTaskFlowInfo	(	String	type,
		String	dn
	)

Get information about a specific taskflow.

Information include a description of the task flow, and some possible usage statistics.

Note:

This method is intended for human interaction, e.g. rendering the response using jsp.

Parameters:

type	Type name of the taskflow.
dn	The dn of the user invoking the method.

Returns:

Some aggregated info about a task flow.

ResponseEntity<Facets> de.zib.gndms.common.GORFX.service.GORFXServiceEssentials.listAvailableFacets

(

String

dn

)

[package]

Lists all facets of the service.

Parameters:

dn	The dn of the user invoking the method.

Returns:

The Facets.

ResponseEntity<List<String> > de.zib.gndms.common.GORFX.service.GORFXServiceEssentials.listTaskFlows

(

String

dn

)

Delivers a list of all supported taskflows.

Parameters:

dn	The dn of the user invoking the method.

Returns:

A list of taskflow names.

---

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

• common/src/de/zib/gndms/common/GORFX/service/GORFXServiceEssentials.java