com.haulmont.bpm.core

Interface ProcessRuntimeManager

All Known Implementing Classes:

ProcessRuntimeManagerBean

public interface ProcessRuntimeManager

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
void	assignProcTask(org.activiti.engine.impl.persistence.entity.TaskEntity taskEntity) Assign an owner to the task that doesn't have an owner yet and updates a joined ProcTask
ProcInstance	cancelProcess(ProcInstance procInstance, java.lang.String comment) Method deletes process instance from activiti engine, updates the procInstance and all tasks of this procInstance
void	claimProcTask(ProcTask procTask, com.haulmont.cuba.security.entity.User user) Claims responsibility for the task
void	completeProcTask(ProcTask procTask, java.lang.String outcome, java.lang.String comment, java.util.Map<java.lang.String,java.lang.Object> processVariables) Signals for activiti engine that a UserTask is completed and updates a procTask object
void	completeProcTaskOnTimer(java.util.UUID procTaskId, java.lang.String outcome) Sets outcome and endDate properties to the given ProcTask.
ProcTask	createNotAssignedProcTask(org.activiti.engine.impl.persistence.entity.TaskEntity taskEntity) Creates new ProcTask that doesn't have assigned user
ProcTask	createProcTask(org.activiti.engine.impl.persistence.entity.TaskEntity actTask) Creates new ProcTask based on activiti TaskEntity
java.lang.Object	evaluateExpression(java.lang.String expression, java.lang.String actExecutionId) Evaluates an UEL expression with a context of activiti process
long	getActiveProcInstanceCount(ProcDefinition procDefinition)
java.lang.String	getSingleTaskAssignee(java.util.UUID procInstanceId, java.lang.String procRoleCode) Finds a single user who is a process actor for given process role.
java.util.List<java.lang.String>	getTaskAssigneeList(java.util.UUID procInstanceId, java.lang.String procRoleCode) Finds all users who are process actors for given process role and returns these users ids.
ProcInstance	startProcess(ProcInstance procInstance, java.lang.String comment, java.util.Map<java.lang.String,java.lang.Object> variables) Starts activiti process and updates the passed procInstance.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

startProcess

ProcInstance startProcess(ProcInstance procInstance,
                          java.lang.String comment,
                          java.util.Map<java.lang.String,java.lang.Object> variables)

Starts activiti process and updates the passed procInstance. When the process is started the following process variables are automatically created:

• bpmProcInstanceId - current ProcInstance object id
• entityId - linked entity id
• entityName - linked entity name

If the process instance passed is new then it will persisted together with its process actors

Parameters:

procInstance - process instance.

comment - start process comment. Can be null.

variables - variables that should be added to the process. Can be null.

Returns:

updated ProcInstance

cancelProcess

ProcInstance cancelProcess(ProcInstance procInstance,
                           java.lang.String comment)

Method deletes process instance from activiti engine, updates the procInstance and all tasks of this procInstance

Parameters:

procInstance - procInstance to be cancelled

comment - cancellation comment that will be written to the procInstance

Returns:

modified procInstance

getTaskAssigneeList

java.util.List<java.lang.String> getTaskAssigneeList(java.util.UUID procInstanceId,
                                                     java.lang.String procRoleCode)

Finds all users who are process actors for given process role and returns these users ids.

Returns:

list of users' ids string representations

getSingleTaskAssignee

java.lang.String getSingleTaskAssignee(java.util.UUID procInstanceId,
                                       java.lang.String procRoleCode)

Finds a single user who is a process actor for given process role. If multiple users are assigned to the role then an exception will be thrown.

Returns:

string representation of user id

completeProcTask

void completeProcTask(ProcTask procTask,
                      java.lang.String outcome,
                      java.lang.String comment,
                      java.util.Map<java.lang.String,java.lang.Object> processVariables)

Signals for activiti engine that a UserTask is completed and updates a procTask object

Parameters:

procTask - process task to be completed

outcome - an outcome that will be written to the procTask

comment - a comment that will be written to the procTask

processVariables - variables to be set into activiti process

completeProcTaskOnTimer

void completeProcTaskOnTimer(java.util.UUID procTaskId,
                             java.lang.String outcome)

Sets outcome and endDate properties to the given ProcTask. In contrast to completeProcTask(ProcTask, String, String, Map) this method doesn't set any process variables that store an outcome

claimProcTask

void claimProcTask(ProcTask procTask,
                   com.haulmont.cuba.security.entity.User user)

Claims responsibility for the task

Parameters:

procTask - process task to claim

user - user that claims the task

getActiveProcInstanceCount

long getActiveProcInstanceCount(ProcDefinition procDefinition)

Returns:

a number of active ProcInstance objects with a given procDefinition

evaluateExpression

java.lang.Object evaluateExpression(java.lang.String expression,
                                    java.lang.String actExecutionId)

Evaluates an UEL expression with a context of activiti process

Parameters:

expression - expression string

actExecutionId - activiti execution id

Returns:

expression evaluation result

createProcTask

ProcTask createProcTask(org.activiti.engine.impl.persistence.entity.TaskEntity actTask)

Creates new ProcTask based on activiti TaskEntity

Parameters:

actTask - activiti TaskEntity

Returns:

created ProcTask

assignProcTask

void assignProcTask(org.activiti.engine.impl.persistence.entity.TaskEntity taskEntity)

Assign an owner to the task that doesn't have an owner yet and updates a joined ProcTask

Parameters:

taskEntity - activiti TaskEntity

createNotAssignedProcTask

ProcTask createNotAssignedProcTask(org.activiti.engine.impl.persistence.entity.TaskEntity taskEntity)

Creates new ProcTask that doesn't have assigned user

Parameters:

taskEntity - activiti TaskEntity

Returns:

creates ProcTask