org.nuxeo.ecm.platform.task.core.service

Class DocumentTaskProvider

java.lang.Object

org.nuxeo.ecm.platform.task.core.service.DocumentTaskProvider

All Implemented Interfaces:

Serializable, TaskProvider

public class DocumentTaskProvider
extends Object
implements TaskProvider

Since:

5.5

Author:

Laurent Doguin

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentTaskProvider()

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 coreSession) Returns the list of task instances associated with this document for which the user is the actor or belongs to the pooled actor list.
static List<Task>	wrapDocModelInTask(DocumentModelList taskDocuments)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentTaskProvider

public DocumentTaskProvider()

Method Detail

getCurrentTaskInstances

public List<Task> getCurrentTaskInstances(CoreSession coreSession)
                                   throws ClientException

Specified by:

getCurrentTaskInstances in interface TaskProvider

Returns:

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

Throws:

ClientException

getCurrentTaskInstances

public 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.

Specified by:

getCurrentTaskInstances in interface TaskProvider

Parameters:

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

filter -

Returns:

Throws:

ClientException

getTaskInstances

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

Description copied from interface: TaskProvider

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.

Specified by:

getTaskInstances in interface TaskProvider

Parameters:

dm - the document.

Returns:

Throws:

ClientException

getTaskInstances

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

Description copied from interface: TaskProvider

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

Specified by:

getTaskInstances in interface TaskProvider

Returns:

Throws:

ClientException

wrapDocModelInTask

public static List<Task> wrapDocModelInTask(DocumentModelList taskDocuments)