org.nuxeo.ecm.platform.task

Interface TaskProvider

All Superinterfaces:

Serializable

All Known Subinterfaces:

TaskService

All Known Implementing Classes:

DocumentTaskProvider, JBPMDocTaskProvider, TaskServiceImpl

public interface TaskProvider
extends Serializable

Since:

5.5

Author:

Laurent Doguin

Method Summary

Methods

Modifier and Type	Method and Description
List<Task>	getCurrentTaskInstances(CoreSession coreSession)
List<Task>	getCurrentTaskInstances(List<String> actors, CoreSession coreSession) Returns a list of task instances assigned to one of the actors in the list or to its pool.
List<Task>	getTaskInstances(DocumentModel dm, List<String> actors, CoreSession coreSession) Returns the list of task instances associated with this document assigned to one of the actor in the list or its pool.
List<Task>	getTaskInstances(DocumentModel dm, NuxeoPrincipal user, CoreSession coreSssion) Returns the list of task instances associated with this document for which the user is the actor or belongs to the pooled actor list.

Method Detail

getCurrentTaskInstances

List<Task> getCurrentTaskInstances(CoreSession coreSession)
                                   throws ClientException

Parameters:

coreSession -

Returns:

A list of task instances visible by the coreSession's user.

Throws:

IllegalStateException - If the currentUser is null.

ClientException

getCurrentTaskInstances

List<Task> getCurrentTaskInstances(List<String> actors,
                                 CoreSession coreSession)
                                   throws ClientException

Returns a list of task instances assigned to one of the actors in the list or to its pool.

Parameters:

actors - a list used as actorId to retrieve the tasks.

coreSession -

Returns:

Throws:

ClientException

getTaskInstances

List<Task> getTaskInstances(DocumentModel dm,
                          NuxeoPrincipal user,
                          CoreSession coreSssion)
                            throws ClientException

Returns the list of task instances associated with this document for which the user is the actor or belongs to the pooled actor list.

If the user is null, then it returns all task instances for the document.

Parameters:

dm - the document.

user -

coreSession -

Returns:

Throws:

ClientException

getTaskInstances

List<Task> getTaskInstances(DocumentModel dm,
                          List<String> actors,
                          CoreSession coreSession)
                            throws ClientException

Returns the list of task instances associated with this document assigned to one of the actor in the list or its pool.

Parameters:

dm -

actors -

coreSession -

Returns:

Throws:

ClientException