org.nuxeo.ecm.platform.jbpm

Interface JbpmTaskService

All Superinterfaces:

Serializable

All Known Implementing Classes:

JbpmTaskServiceImpl

public interface JbpmTaskService
extends Serializable

Service offering JPBM methods to create and end tasks independently from a process.

JbpmService is called by this service to handle the task.

Author:

Anahide Tchertchian

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JbpmTaskService.TaskVariableName Variable names added as markers on the created task

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
void	acceptTask(CoreSession coreSession, NuxeoPrincipal principal, TaskInstance task, String comment) Ends the task using event name JbpmEventNames.WORKFLOW_TASK_COMPLETED and marking the task as validated.
boolean	canEndTask(NuxeoPrincipal principal, TaskInstance task) Returns true if user is an administrator, the initiator of the task, or an actor of the task.
void	createTask(CoreSession coreSession, NuxeoPrincipal principal, DocumentModel document, String taskName, List<String> prefixedActorIds, boolean createOneTaskPerActor, String directive, String comment, Date dueDate, Map<String,Serializable> taskVariables) Creates a task and starts it.
void	endTask(CoreSession coreSession, NuxeoPrincipal principal, TaskInstance task, String comment, String eventName, boolean isValidated) Ends the task
void	rejectTask(CoreSession coreSession, NuxeoPrincipal principal, TaskInstance task, String comment) Ends the task using event name JbpmEventNames.WORKFLOW_TASK_REJECTED and marking the task as not validated.

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

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

Creates a task and starts it. Notifies events with names JbpmEventNames.WORKFLOW_TASK_ASSIGNED and JbpmEventNames.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

Throws:

NuxeoJbpmException

canEndTask

boolean canEndTask(NuxeoPrincipal principal,
                 TaskInstance task)
                   throws NuxeoJbpmException

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

Throws:

NuxeoJbpmException

acceptTask

void acceptTask(CoreSession coreSession,
              NuxeoPrincipal principal,
              TaskInstance task,
              String comment)
                throws NuxeoJbpmException

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

Throws:

NuxeoJbpmException

See Also:

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

rejectTask

void rejectTask(CoreSession coreSession,
              NuxeoPrincipal principal,
              TaskInstance task,
              String comment)
                throws NuxeoJbpmException

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

Throws:

NuxeoJbpmException

See Also:

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

endTask

void endTask(CoreSession coreSession,
           NuxeoPrincipal principal,
           TaskInstance task,
           String comment,
           String eventName,
           boolean isValidated)
             throws NuxeoJbpmException

Ends the task

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 event name to use when notifying

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

Throws:

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