org.nuxeo.ecm.platform.task

Interface TaskService

All Superinterfaces:

Serializable, TaskProvider

All Known Implementing Classes:

TaskServiceImpl

public interface TaskService
extends Serializable, TaskProvider

The task service handle document based Tasks. You can create, search, accept, end or reject tasks. An event is launched when a task is ended, hence giving you the possibility to execute specific code.

Since:

5.5

Author:

Laurent Doguin

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TaskService.VariableName The variable used as process instance variables.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TASK_INSTANCE_EVENT_PROPERTIES_KEY Property used to pass task in the notified events properties

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.
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> 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 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> prefixedActorIds, 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.
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) Ends the task
DocumentModel	getTargetDocumentModel(Task ti, CoreSession coreSession)
Task	getTask(CoreSession coreSession, String taskId)
String	getTaskRootParentPath(CoreSession coreSession) Default value is /task-root
void	reassignTask(CoreSession session, String taskId, List<String> actors, String comment) Reassign the given task to the list of actors.
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.

Methods inherited from interface org.nuxeo.ecm.platform.task.TaskProvider

getAllTaskInstances, getAllTaskInstances, getAllTaskInstances, getAllTaskInstances, getCurrentTaskInstances, getCurrentTaskInstances, getTaskInstances, getTaskInstances

Field Detail

TASK_INSTANCE_EVENT_PROPERTIES_KEY

static final String TASK_INSTANCE_EVENT_PROPERTIES_KEY

Property used to pass task in the notified events properties

See Also:

Constant Field Values

Method Detail

createTask

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

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 TASK_INSTANCE_EVENT_PROPERTIES_KEY

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.

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

createTask

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

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 TASK_INSTANCE_EVENT_PROPERTIES_KEY

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

createTask

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

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 TASK_INSTANCE_EVENT_PROPERTIES_KEY Also the map eventInfo is passed in the event properties

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.

the - task document type

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

eventInfo -

Throws:

ClientException

Since:

5.6

canEndTask

boolean canEndTask(NuxeoPrincipal principal,
                 Task task)
                   throws ClientException

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

Throws:

ClientException

acceptTask

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

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

Returns:

the name of the Seam event to raise

Throws:

ClientException

See Also:

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

rejectTask

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

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

Returns:

the name of the Seam event to raise

Throws:

ClientException

See Also:

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

endTask

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

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

deleteTask

void deleteTask(CoreSession coreSession,
              String taskId)
                throws ClientException

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

Parameters:

coreSession -

taskId -

Throws:

ClientException

getTargetDocumentModel

DocumentModel getTargetDocumentModel(Task ti,
                                   CoreSession coreSession)
                                     throws ClientException

Parameters:

ti - the task.

user - the user.

Returns:

the task's target document.

Throws:

ClientException

getTask

Task getTask(CoreSession coreSession,
           String taskId)
             throws ClientException

Parameters:

coreSession -

taskId -

Returns:

the taskDocument with the given taskId

Throws:

ClientException

getTaskRootParentPath

String getTaskRootParentPath(CoreSession coreSession)

Default value is /task-root

Returns:

the path registered in the taskPersister extension point.

reassignTask

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

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.

Parameters:

session -

taskId -

actors -

Throws:

ClientException

Since:

5.7.3