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

Class TaskServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

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

All Implemented Interfaces:

Serializable, TaskProvider, TaskService, Adaptable, Component, Extensible, TimestampedService

public class TaskServiceImpl
extends DefaultComponent
implements TaskService

Since:

5.5

Author:

Laurent Doguin

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TaskServiceImpl.GetTaskRootParentPathUnrestricted

Nested classes/interfaces inherited from interface org.nuxeo.ecm.platform.task.TaskService

TaskService.VariableName

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TASK_PROVIDER
static ComponentName	NAME

Fields inherited from interface org.nuxeo.ecm.platform.task.TaskService

TASK_INSTANCE_EVENT_PROPERTIES_KEY

Constructor Summary

Constructors

Constructor and Description
TaskServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
String	acceptTask(CoreSession coreSession, NuxeoPrincipal principal, Task task, String comment) Ends the task using event name TaskEventNames.WORKFLOW_TASK_COMPLETED and marking the task as validated.
void	activate(ComponentContext context) Activates the component.
boolean	canEndTask(NuxeoPrincipal principal, Task task) Returns true if user is an administrator, the initiator of the task, or an actor of the task.
List<Task>	createTask(CoreSession coreSession, NuxeoPrincipal principal, DocumentModel document, String taskName, List<String> actorIds, boolean createOneTaskPerActor, String directive, String comment, Date dueDate, Map<String,String> taskVariables, String parentPath) Creates a task and starts it.
List<Task>	createTask(CoreSession coreSession, NuxeoPrincipal principal, DocumentModel document, String taskName, String taskType, String processId, List<String> prefixedActorIds, boolean createOneTaskPerActor, String directive, String comment, Date dueDate, Map<String,String> taskVariables, String parentPath) Creates a task and starts it.
List<Task>	createTask(CoreSession coreSession, NuxeoPrincipal principal, DocumentModel document, String taskDocumentType, String taskName, String taskType, String processId, List<String> actorIds, boolean createOneTaskPerActor, String directive, String comment, Date dueDate, Map<String,String> taskVariables, String parentPath, Map<String,Serializable> eventInfo) Creates a task of the given document type and starts it.
List<Task>	createTask(CoreSession coreSession, NuxeoPrincipal principal, List<DocumentModel> documents, String taskDocumentType, String taskName, String taskType, String processId, List<String> actorIds, boolean createOneTaskPerActor, String directive, String comment, Date dueDate, Map<String,String> taskVariables, String parentPath, Map<String,Serializable> eventInfo) Creates a task of the given documents type and starts it.
void	deactivate(ComponentContext context) Deactivates the component.
void	delegateTask(CoreSession session, String taskId, List<String> delegatedActors, String comment) Delegates the given task to the list of actors.
void	deleteTask(CoreSession coreSession, String taskId) Remove the documentTask identified by the given taskId if coreSession's principal has the Remove permission.
String	endTask(CoreSession coreSession, NuxeoPrincipal principal, Task task, String comment, String eventName, boolean isValidated) Use the task provider held by the Task.TASK_PROVIDER_KEY task variable to end 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(List<String> actors, CoreSession coreSession) Returns a list of task instances assigned to one of the actors in the list or to its pool.
DocumentModel	getTargetDocumentModel(Task task, CoreSession coreSession)
Task	getTask(CoreSession coreSession, String taskId)
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.
String	getTaskRootParentPath(CoreSession coreSession) Default value is /task-root
void	reassignTask(CoreSession session, String taskId, List<String> newActors, String comment) Reassign the given task to the list of actors.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
String	rejectTask(CoreSession coreSession, NuxeoPrincipal principal, Task task, String comment) Ends the task using event name TaskEventNames.WORKFLOW_TASK_REJECTED and marking the task as not validated.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final ComponentName NAME

DEFAULT_TASK_PROVIDER

public static final String DEFAULT_TASK_PROVIDER

See Also:

Constant Field Values

Constructor Detail

TaskServiceImpl

public TaskServiceImpl()

Method Detail

activate

public void activate(ComponentContext context)
              throws Exception

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

deactivate

public void deactivate(ComponentContext context)
                throws Exception

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)
                          throws Exception

Overrides:

registerContribution in class DefaultComponent

Throws:

Exception

unregisterContribution

public void unregisterContribution(Object contribution,
                          String extensionPoint,
                          ComponentInstance contributor)
                            throws Exception

Overrides:

unregisterContribution in class DefaultComponent

Throws:

Exception

createTask

public List<Task> createTask(CoreSession coreSession,
                    NuxeoPrincipal principal,
                    DocumentModel document,
                    String taskName,
                    List<String> actorIds,
                    boolean createOneTaskPerActor,
                    String directive,
                    String comment,
                    Date dueDate,
                    Map<String,String> taskVariables,
                    String parentPath)
                      throws ClientException

Description copied from interface: TaskService

Creates a task and starts it. Notifies events with names TaskEventNames.WORKFLOW_TASK_ASSIGNED and TaskEventNames.WORKFLOW_TASK_ASSIGNED, passing the task in the event properties using key TaskService.TASK_INSTANCE_EVENT_PROPERTIES_KEY

Specified by:

createTask in interface TaskService

Parameters:

coreSession - the session to use when notifying

principal - the principal marked as initiator of the task and used when notifying.

document - the document to attach to the task.

taskName - the task name.

actorIds - the list of actor ids, prefixed with 'user:' or 'group:'.

createOneTaskPerActor - if true, one task will be created per actor, else a single task will be assigned to all actors.

directive - the directive, put in the task variables.

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

dueDate - the due date, set on the task instance

taskVariables - additional task variables

parentPath - /task-root if null

Throws:

ClientException

createTask

public List<Task> createTask(CoreSession coreSession,
                    NuxeoPrincipal principal,
                    DocumentModel document,
                    String taskDocumentType,
                    String taskName,
                    String taskType,
                    String processId,
                    List<String> actorIds,
                    boolean createOneTaskPerActor,
                    String directive,
                    String comment,
                    Date dueDate,
                    Map<String,String> taskVariables,
                    String parentPath,
                    Map<String,Serializable> eventInfo)
                      throws ClientException

Description copied from interface: TaskService

Creates a task of the given document type and starts it. Notifies events with names TaskEventNames.WORKFLOW_TASK_ASSIGNED and TaskEventNames.WORKFLOW_TASK_ASSIGNED, passing the task in the event properties using key TaskService.TASK_INSTANCE_EVENT_PROPERTIES_KEY Also the map eventInfo is passed in the event properties

Specified by:

createTask in interface TaskService

Parameters:

coreSession - the session to use when notifying

principal - the principal marked as initiator of the task and used when notifying.

document - the document to attach to the task.

taskName - the task name.

taskType - the task type.

processId - the process ID linked to this task if any.

actorIds - the list of actor ids, prefixed with 'user:' or 'group:'.

createOneTaskPerActor - if true, one task will be created per actor, else a single task will be assigned to all actors.

directive - the directive, put in the task variables.

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

dueDate - the due date, set on the task instance

taskVariables - additional task variables

parentPath - /task-root if null

Throws:

ClientException

Since:

5.6

createTask

public List<Task> createTask(CoreSession coreSession,
                    NuxeoPrincipal principal,
                    DocumentModel document,
                    String taskName,
                    String taskType,
                    String processId,
                    List<String> prefixedActorIds,
                    boolean createOneTaskPerActor,
                    String directive,
                    String comment,
                    Date dueDate,
                    Map<String,String> taskVariables,
                    String parentPath)
                      throws ClientException

Description copied from interface: TaskService

Creates a task and starts it. Notifies events with names TaskEventNames.WORKFLOW_TASK_ASSIGNED and TaskEventNames.WORKFLOW_TASK_ASSIGNED, passing the task in the event properties using key TaskService.TASK_INSTANCE_EVENT_PROPERTIES_KEY

Specified by:

createTask in interface TaskService

Parameters:

coreSession - the session to use when notifying

principal - the principal marked as initiator of the task and used when notifying.

document - the document to attach to the task.

taskName - the task name.

taskType - the task type.

processId - the process ID linked to this task if any.

prefixedActorIds - the list of actor ids, prefixed with 'user:' or 'group:'.

createOneTaskPerActor - if true, one task will be created per actor, else a single task will be assigned to all actors.

directive - the directive, put in the task variables.

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

dueDate - the due date, set on the task instance

taskVariables - additional task variables

parentPath - /task-root if null

Throws:

ClientException

Since:

5.6

acceptTask

public String acceptTask(CoreSession coreSession,
                NuxeoPrincipal principal,
                Task task,
                String comment)
                  throws ClientException

Description copied from interface: TaskService

Ends the task using event name TaskEventNames.WORKFLOW_TASK_COMPLETED and marking the task as validated.

Specified by:

acceptTask in interface TaskService

Returns:

the name of the Seam event to raise

Throws:

ClientException

See Also:

TaskService.endTask(CoreSession, NuxeoPrincipal, Task, String, String, boolean)

rejectTask

public String rejectTask(CoreSession coreSession,
                NuxeoPrincipal principal,
                Task task,
                String comment)
                  throws ClientException

Description copied from interface: TaskService

Ends the task using event name TaskEventNames.WORKFLOW_TASK_REJECTED and marking the task as not validated.

Specified by:

rejectTask in interface TaskService

Returns:

the name of the Seam event to raise

Throws:

ClientException

See Also:

TaskService.endTask(CoreSession, NuxeoPrincipal, Task, String, String, boolean)

endTask

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

Use the task provider held by the Task.TASK_PROVIDER_KEY task variable to end the task. If null use the DEFAULT_TASK_PROVIDER.

Specified by:

endTask in interface TaskProvider

Specified by:

endTask in interface TaskService

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 TaskService.canEndTask(NuxeoPrincipal, Task)), or when any other error occurs

canEndTask

public boolean canEndTask(NuxeoPrincipal principal,
                 Task task)
                   throws ClientException

Description copied from interface: TaskService

Returns true if user is an administrator, the initiator of the task, or an actor of the task.

Specified by:

canEndTask in interface TaskService

Throws:

ClientException

getTask

public Task getTask(CoreSession coreSession,
           String taskId)
             throws ClientException

Specified by:

getTask in interface TaskService

Returns:

the taskDocument with the given taskId

Throws:

ClientException

deleteTask

public void deleteTask(CoreSession coreSession,
              String taskId)
                throws ClientException

Description copied from interface: TaskService

Remove the documentTask identified by the given taskId if coreSession's principal has the Remove permission.

Specified by:

deleteTask in interface TaskService

Throws:

ClientException

getTargetDocumentModel

public DocumentModel getTargetDocumentModel(Task task,
                                   CoreSession coreSession)
                                     throws ClientException

Specified by:

getTargetDocumentModel in interface TaskService

Parameters:

task - the task.

Returns:

the task's target document.

Throws:

ClientException

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

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

getTaskRootParentPath

public String getTaskRootParentPath(CoreSession coreSession)

Description copied from interface: TaskService

Default value is /task-root

Specified by:

getTaskRootParentPath in interface TaskService

Returns:

the path registered in the taskPersister extension point.

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

reassignTask

public void reassignTask(CoreSession session,
                String taskId,
                List<String> newActors,
                String comment)
                  throws ClientException

Description copied from interface: TaskService

Reassign the given task to the list of actors. The ACLs set for current assignees and task initiator are removed and new actors are granted 'Manage everything' on the task document. The 'workflowTaskReassigned' event is triggered.

Specified by:

reassignTask in interface TaskService

Throws:

ClientException

delegateTask

public void delegateTask(CoreSession session,
                String taskId,
                List<String> delegatedActors,
                String comment)
                  throws ClientException

Description copied from interface: TaskService

Delegates the given task to the list of actors. The new actors are granted 'Manage everything' on the task document. The 'workflowTaskDelegated' event is triggered.

Specified by:

delegateTask in interface TaskService

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

createTask

public List<Task> createTask(CoreSession coreSession,
                    NuxeoPrincipal principal,
                    List<DocumentModel> documents,
                    String taskDocumentType,
                    String taskName,
                    String taskType,
                    String processId,
                    List<String> actorIds,
                    boolean createOneTaskPerActor,
                    String directive,
                    String comment,
                    Date dueDate,
                    Map<String,String> taskVariables,
                    String parentPath,
                    Map<String,Serializable> eventInfo)
                      throws ClientException

Description copied from interface: TaskService

Creates a task of the given documents type and starts it. Notifies events with names TaskEventNames.WORKFLOW_TASK_ASSIGNED and TaskEventNames.WORKFLOW_TASK_ASSIGNED, passing the task in the event properties using key TaskService.TASK_INSTANCE_EVENT_PROPERTIES_KEY Also the map eventInfo is passed in the event properties

Specified by:

createTask in interface TaskService

Parameters:

coreSession - the session to use when notifying

principal - the principal marked as initiator of the task and used when notifying.

documents - the documents to attach to the task.

taskName - the task name.

taskType - the task type.

processId - the process ID linked to this task if any.

actorIds - the list of actor ids, prefixed with 'user:' or 'group:'.

createOneTaskPerActor - if true, one task will be created per actor, else a single task will be assigned to all actors.

directive - the directive, put in the task variables.

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

dueDate - the due date, set on the task instance

taskVariables - additional task variables

parentPath - /task-root if null

Throws:

ClientException

Since:

5.8