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, Antoine Taillefer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentTaskProvider()

Method Summary

Methods

Modifier and Type	Method and Description
String	endTask(CoreSession coreSession, NuxeoPrincipal principal, Task task, String comment, String eventName, boolean isValidated) Ends the task
List<Task>	getAllTaskInstances(String processId, CoreSession session) Returns all the tasks instances for the given processId.
List<Task>	getAllTaskInstances(String processId, List<String> actors, CoreSession session) Returns all the tasks instances for the given processId which assigned to one of the actor in the list or its pool.
List<Task>	getAllTaskInstances(String processId, NuxeoPrincipal user, CoreSession session) Returns all the tasks instances for the given processId and where the user is the actor or belongs to the pooled actor list.
List<Task>	getAllTaskInstances(String processId, String nodeId, CoreSession session) Returns all the tasks instances for the given processId originating from the given nodeId.
List<Task>	getCurrentTaskInstances(CoreSession coreSession)
List<Task>	getCurrentTaskInstances(CoreSession coreSession, List<SortInfo> sortInfos) Provide @param sortInfo to handle sort page-provider contributions (see getCurrentTaskInstances(org.nuxeo.ecm.core.api.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>	getCurrentTaskInstances(List<String> actors, CoreSession coreSession, List<SortInfo> sortInfos) Provide @param sortInfo to handle sort page-provider contributions (see getCurrentTaskInstances(org.nuxeo.ecm.core.api.CoreSession))
List<Task>	getTaskInstances(DocumentModel dm, List<String> actors, boolean includeDelegatedTasks, CoreSession session) 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, 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>	getTasks(String pageProviderName, CoreSession session, boolean unrestricted, List<SortInfo> sortInfos, Object... params)
static List<Task>	wrapDocModelInTask(DocumentModelList taskDocuments) Deprecated. since 6.0, use wrapDocModelInTask(List) instead.
static List<Task>	wrapDocModelInTask(DocumentModelList taskDocuments, boolean detach) Deprecated. since 6.0, use wrapDocModelInTask(List) instead.
static List<Task>	wrapDocModelInTask(List<DocumentModel> taskDocuments) Converts a DocumentModelList to a list of Tasks.

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 where the current user is an actor. Doesn't take into account tasks that were delegated to this user.

Throws:

ClientException

getCurrentTaskInstances

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

Provide @param sortInfo to handle sort page-provider contributions (see getCurrentTaskInstances(org.nuxeo.ecm.core.api.CoreSession))

Specified by:

getCurrentTaskInstances in interface TaskProvider

Throws:

ClientException

Since:

5.9.3

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

getCurrentTaskInstances

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

Provide @param sortInfo to handle sort page-provider contributions (see getCurrentTaskInstances(org.nuxeo.ecm.core.api.CoreSession))

Specified by:

getCurrentTaskInstances in interface TaskProvider

Throws:

ClientException

Since:

5.9.3

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. Doesn't take into account tasks that were delegated to this user.

If the user is null, then it returns all task instances for the document. The query is done in unrestricted mode and so the documents linked to the tasks are detached.

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. Doesn't take into account tasks that were delegated to these users. The query is done in unrestricted mode and so the documents linked to the tasks are detached.

Specified by:

getTaskInstances in interface TaskProvider

Returns:

Throws:

ClientException

getAllTaskInstances

public List<Task> getAllTaskInstances(String processId,
                             CoreSession session)
                               throws ClientException

Description copied from interface: TaskProvider

Returns all the tasks instances for the given processId.

The query is done in unrestricted mode and so the documents linked to the tasks are detached.

Specified by:

getAllTaskInstances in interface TaskProvider

Throws:

ClientException

getAllTaskInstances

public List<Task> getAllTaskInstances(String processId,
                             NuxeoPrincipal user,
                             CoreSession session)
                               throws ClientException

Description copied from interface: TaskProvider

Returns all the tasks instances for the given processId and where the user is the actor or belongs to the pooled actor list. Doesn't take into account tasks that were delegated to this user.

The query is done in unrestricted mode and so the documents linked to the tasks are detached.

Specified by:

getAllTaskInstances in interface TaskProvider

Throws:

ClientException

getAllTaskInstances

public List<Task> getAllTaskInstances(String processId,
                             List<String> actors,
                             CoreSession session)
                               throws ClientException

Description copied from interface: TaskProvider

Returns all the tasks instances for the given processId which assigned to one of the actor in the list or its pool. Doesn't take into account tasks that were delegated to these users.

The query is done in unrestricted mode and so the documents linked to the tasks are detached.

Specified by:

getAllTaskInstances in interface TaskProvider

Throws:

ClientException

wrapDocModelInTask

public static List<Task> wrapDocModelInTask(List<DocumentModel> taskDocuments)

Converts a DocumentModelList to a list of Tasks.

Parameters:

taskDocuments -

Since:

6.0

wrapDocModelInTask

@Deprecated
public static List<Task> wrapDocModelInTask(DocumentModelList taskDocuments)
                                     throws ClientException

Deprecated. since 6.0, use wrapDocModelInTask(List) instead.

Throws:

ClientException

wrapDocModelInTask

@Deprecated
public static List<Task> wrapDocModelInTask(DocumentModelList taskDocuments,
                                       boolean detach)
                                     throws ClientException

Deprecated. since 6.0, use wrapDocModelInTask(List) instead.

Converts a DocumentModelList to a list of Tasks.

Parameters:

detach - if true, detach each document before converting it to a Task.

Throws:

ClientException

endTask

public String endTask(CoreSession coreSession,
             NuxeoPrincipal principal,
             Task task,
             String comment,
             String eventName,
             boolean isValidated)
               throws ClientException

Description copied from interface: TaskProvider

Ends the task

Specified by:

endTask in interface TaskProvider

Parameters:

coreSession - the session to use when notifying and resolving of referenced document for notification.

principal - principal used when notifying

task - the instance to end

comment - string added to the task comments and used as a notification comment

eventName - the core event name to use when notifying

isValidated - boolean marker to state if the task was validated or rejected

Returns:

the name of the Seam event to raise

Throws:

ClientException - when trying to end a task without being granted the right to do so (see #canEndTask(NuxeoPrincipal, Task)), or when any other error occurs

getAllTaskInstances

public List<Task> getAllTaskInstances(String processId,
                             String nodeId,
                             CoreSession session)
                               throws ClientException

Description copied from interface: TaskProvider

Returns all the tasks instances for the given processId originating from the given nodeId.

The query is done in unrestricted mode and so the documents linked to the tasks are detached.

Specified by:

getAllTaskInstances in interface TaskProvider

Throws:

ClientException

getTaskInstances

public List<Task> getTaskInstances(DocumentModel dm,
                          List<String> actors,
                          boolean includeDelegatedTasks,
                          CoreSession session)
                            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. If the parameter includeDelegatedTasks is true, takes into account tasks that were delegated to these users. The query is done in unrestricted mode and so the documents linked to the tasks are detached.

Specified by:

getTaskInstances in interface TaskProvider

Throws:

ClientException

getTasks

public static List<Task> getTasks(String pageProviderName,
                  CoreSession session,
                  boolean unrestricted,
                  List<SortInfo> sortInfos,
                  Object... params)

Since:

6.0