org.alfresco.rest.workflow.api.impl

Class TasksImpl

java.lang.Object

org.alfresco.rest.workflow.api.impl.WorkflowRestImpl

org.alfresco.rest.workflow.api.impl.TasksImpl

All Implemented Interfaces:

Tasks

public class TasksImpl
extends WorkflowRestImpl
implements Tasks

Field Summary

Fields inherited from class org.alfresco.rest.workflow.api.impl.WorkflowRestImpl

activitiProcessEngine, authorityService, BPM_PACKAGE, deployWorkflowsInTenant, dictionaryService, excludeModelTypes, namespaceService, nodeService, tenantService

Constructor Summary

Constructors

Constructor and Description
TasksImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Item	createItem(java.lang.String taskId, Item item)
void	deleteItem(java.lang.String taskId, java.lang.String itemId)
void	deleteTaskVariable(java.lang.String taskId, java.lang.String variableName)
protected java.lang.String	getFormResourceKey(org.activiti.engine.task.Task task)
Item	getItem(java.lang.String taskId, java.lang.String itemId)
CollectionWithPagingInfo	getItems(java.lang.String taskId, Paging paging)
protected org.alfresco.repo.workflow.WorkflowQNameConverter	getQNameConverter()
Task	getTask(java.lang.String taskId)
CollectionWithPagingInfo	getTaskCandidates(java.lang.String taskId, Paging paging)
CollectionWithPagingInfo	getTaskFormModel(java.lang.String taskId, Paging paging)
CollectionWithPagingInfo	getTasks(Parameters parameters)
CollectionWithPagingInfo	getTasks(java.lang.String processId, Parameters parameters)
CollectionWithPagingInfo	getTaskVariables(java.lang.String taskId, Paging paging, VariableScope scope)
protected org.activiti.engine.history.HistoricTaskInstance	getValidHistoricTask(java.lang.String taskId) Get a valid HistoricTaskInstance based on the given task id.
protected org.activiti.engine.task.Task	getValidTask(java.lang.String taskId) Get a valid Task based on the given task id.
protected org.alfresco.repo.workflow.WorkflowObjectFactory	getWorkflowFactory()
void	setMessageService(org.alfresco.repo.i18n.MessageService messageService)
void	setRestVariableHelper(RestVariableHelper restVariableHelper)
Task	update(java.lang.String taskId, Task task, Parameters parameters)
protected boolean	updateTaskProperties(java.util.List selectedProperties, Task task, org.activiti.engine.task.Task taskInstance)
TaskVariable	updateTaskVariable(java.lang.String taskId, TaskVariable taskVariable)
java.util.List	updateTaskVariables(java.lang.String taskId, java.util.List variables)
protected TaskVariable	updateVariableInTask(java.lang.String taskId, org.activiti.engine.task.Task taskInstance, TaskVariable taskVariable)

Methods inherited from class org.alfresco.rest.workflow.api.impl.WorkflowRestImpl

createItemForNodeRef, createItemInProcess, deleteItemFromProcess, getCachedProcessDefinition, getFormModelElements, getItemFromProcess, getItemsFromProcess, getNodeRef, getParameter, getTypesToExclude, setActivitiProcessEngine, setAuthorityService, setDeployWorkflowsInTenant, setDictionaryService, setNamespaceService, setNodeService, setTenantService, validateIfUserAllowedToWorkWithProcess

Methods inherited from class java.lang.Object

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

Constructor Detail

TasksImpl

public TasksImpl()

Method Detail

setRestVariableHelper

public void setRestVariableHelper(RestVariableHelper restVariableHelper)

setMessageService

public void setMessageService(org.alfresco.repo.i18n.MessageService messageService)

getTasks

public CollectionWithPagingInfo getTasks(Parameters parameters)

Specified by:

getTasks in interface Tasks

getTasks

public CollectionWithPagingInfo getTasks(java.lang.String processId,
                                Parameters parameters)

Specified by:

getTasks in interface Tasks

getTask

public Task getTask(java.lang.String taskId)

Specified by:

getTask in interface Tasks

update

public Task update(java.lang.String taskId,
          Task task,
          Parameters parameters)

Specified by:

update in interface Tasks

getTaskFormModel

public CollectionWithPagingInfo getTaskFormModel(java.lang.String taskId,
                                        Paging paging)

Specified by:

getTaskFormModel in interface Tasks

getTaskVariables

public CollectionWithPagingInfo getTaskVariables(java.lang.String taskId,
                                        Paging paging,
                                        VariableScope scope)

Specified by:

getTaskVariables in interface Tasks

updateTaskVariable

public TaskVariable updateTaskVariable(java.lang.String taskId,
                              TaskVariable taskVariable)

Specified by:

updateTaskVariable in interface Tasks

updateTaskVariables

public java.util.List updateTaskVariables(java.lang.String taskId,
                                 java.util.List variables)

Specified by:

updateTaskVariables in interface Tasks

updateVariableInTask

protected TaskVariable updateVariableInTask(java.lang.String taskId,
                                org.activiti.engine.task.Task taskInstance,
                                TaskVariable taskVariable)

deleteTaskVariable

public void deleteTaskVariable(java.lang.String taskId,
                      java.lang.String variableName)

Specified by:

deleteTaskVariable in interface Tasks

getTaskCandidates

public CollectionWithPagingInfo getTaskCandidates(java.lang.String taskId,
                                         Paging paging)

Specified by:

getTaskCandidates in interface Tasks

createItem

public Item createItem(java.lang.String taskId,
              Item item)

Specified by:

createItem in interface Tasks

deleteItem

public void deleteItem(java.lang.String taskId,
              java.lang.String itemId)

Specified by:

deleteItem in interface Tasks

getItem

public Item getItem(java.lang.String taskId,
           java.lang.String itemId)

Specified by:

getItem in interface Tasks

getItems

public CollectionWithPagingInfo getItems(java.lang.String taskId,
                                Paging paging)

Specified by:

getItems in interface Tasks

getFormResourceKey

protected java.lang.String getFormResourceKey(org.activiti.engine.task.Task task)

updateTaskProperties

protected boolean updateTaskProperties(java.util.List selectedProperties,
                           Task task,
                           org.activiti.engine.task.Task taskInstance)

Returns:

true, if at least one task property has been changed based on the given parameters.

getValidHistoricTask

protected org.activiti.engine.history.HistoricTaskInstance getValidHistoricTask(java.lang.String taskId)

Get a valid HistoricTaskInstance based on the given task id. Checks if current logged in user is assignee/owner/involved with the task. In case true was passed for "validIfClaimable", the task is also valid if the current logged in user is a candidate for claiming the task.

Throws:

EntityNotFoundException - when the task was not found

PermissionDeniedException - when the current logged in user isn't allowed to access task.

getValidTask

protected org.activiti.engine.task.Task getValidTask(java.lang.String taskId)

Get a valid Task based on the given task id. Checks if current logged in user is assignee/owner/involved with the task. In case true was passed for "validIfClaimable", the task is also valid if the current logged in user is a candidate for claiming the task.

Throws:

EntityNotFoundException - when the task was not found

PermissionDeniedException - when the current logged in user isn't allowed to access task.

getQNameConverter

protected org.alfresco.repo.workflow.WorkflowQNameConverter getQNameConverter()

getWorkflowFactory

protected org.alfresco.repo.workflow.WorkflowObjectFactory getWorkflowFactory()