com.tsgrp.opencontent.activiti.util

Class ActivitiUtil

java.lang.Object

com.tsgrp.opencontent.activiti.util.ActivitiUtil

public class ActivitiUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ActivitiUtil()

Method Summary

Modifier and Type	Method and Description
static java.util.List<WorkflowInstance>	activitiProcessInstancesToOCWorkflowInstances(java.lang.String ticket, java.util.List<org.activiti.engine.runtime.ProcessInstance> instances)
static WorkflowInstance	activitiProcessInstanceToOCWorkflowInstance(java.lang.String ticket, org.activiti.engine.runtime.ProcessInstance pi)
static java.util.List<TaskInstance>	activitiTasksToOCTaskInstances(java.util.List<org.activiti.engine.task.Task> tasks, java.lang.String ticket, org.activiti.engine.TaskService taskService, org.activiti.engine.RepositoryService repositoryService)
static TaskInstance	activitiTaskToOCTaskInstance(org.activiti.engine.task.Task actTask, java.util.Map actTaskVariables, java.lang.String ticket, org.activiti.engine.TaskService taskService, org.activiti.engine.RepositoryService repositoryService)
static java.util.Map<java.lang.String,java.lang.Object>	addAssigneesToModelFromExecution(org.activiti.engine.delegate.DelegateExecution execution, java.util.Map<java.lang.String,java.lang.Object> model) This will add the standard workflow bpm_assignees and bpm_groupAssignee to any model that adheres to the Map format
static void	copyExecutionDueDateToTaskDueDate(org.activiti.engine.delegate.DelegateTask task) Method that copies the workflow execution due date (bpm_workflowDueDate) to the task due date.
static void	copyTaskDueDateToExecutionDueDate(org.activiti.engine.delegate.DelegateTask task) Method that copies the bpm_workflowDueDate property on the task up to the workflow execution due date.
static WorkflowInstanceSnapshot	createWorkflowSnapshotInstance(java.lang.String ticket, WorkflowInstance workflowInstance, java.util.List<TaskInstance> taskInstances)
static java.util.List<org.activiti.engine.task.Task>	getActivitiTasks(java.lang.String userLoginName, java.lang.String workflowInstanceId, java.lang.String taskName)
static java.util.List<org.activiti.engine.task.Task>	getActivitiTasks(java.lang.String userLoginName, java.lang.String workflowInstanceId, java.lang.String taskName, int limit)
static java.util.List<java.lang.String>	getAssigneesFromParam(java.lang.Object assigneesParam) The assigneesParam can either be a List or a String.
static java.util.List<org.activiti.engine.history.HistoricActivityInstance>	getHistoricTasks(java.lang.String userLoginName, java.lang.String workflowInstanceId, java.lang.String taskName) Fetches all of the HistoricActivityInstances that match the included parameters.
static java.util.List<org.activiti.engine.history.HistoricActivityInstance>	getHistoricTasks(java.lang.String userLoginName, java.lang.String workflowInstanceId, java.lang.String taskName, int limit) Fetches a list of size @param limit of the HistoricActivityInstances that match the included parameters.
static java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getListOfMapsVariable(org.activiti.engine.delegate.DelegateTask task, java.lang.String variableKey) Retrieves an Activity variable from the given DelegateTask as a List of Maps.
static java.util.Map<java.lang.String,java.lang.Object>	getMapVariable(org.activiti.engine.delegate.DelegateTask task, java.lang.String variableKey) Retrieves an Activity variable from the given DelegateTask as a Map.
static java.util.Map<java.lang.String,java.lang.Object>	getMapVariable(java.util.Map<java.lang.String,java.lang.Object> variables, java.lang.String variableKey) Retrieves an Activiti variable in the variable map as a Map.
static byte[]	sanitizeMapForActivitiVariable(java.util.Map<java.lang.String,java.lang.Object> map) Activiti cannot handle storing a HashMap into a worflow variable.
static void	setAssigneeDecisionVariables(org.activiti.engine.delegate.DelegateExecution execution) Helper function to set the groupAssigneeExists and individualAssigneeExists execution variables based on if the standard assignee variables are set.
static void	setMapVariable(org.activiti.engine.delegate.DelegateTask task, java.lang.String variableKey, java.util.Map<java.lang.String,java.lang.Object> value, boolean isLocal) Sets a Map variable into the given DelegateTask.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivitiUtil

public ActivitiUtil()

Method Detail

getActivitiTasks

public static java.util.List<org.activiti.engine.task.Task> getActivitiTasks(java.lang.String userLoginName,
                                                                             java.lang.String workflowInstanceId,
                                                                             java.lang.String taskName)

getActivitiTasks

public static java.util.List<org.activiti.engine.task.Task> getActivitiTasks(java.lang.String userLoginName,
                                                                             java.lang.String workflowInstanceId,
                                                                             java.lang.String taskName,
                                                                             int limit)

getHistoricTasks

public static java.util.List<org.activiti.engine.history.HistoricActivityInstance> getHistoricTasks(java.lang.String userLoginName,
                                                                                                    java.lang.String workflowInstanceId,
                                                                                                    java.lang.String taskName)

Fetches all of the HistoricActivityInstances that match the included parameters. If a parameter is left blank it is not included in the query and will be ignored

Parameters:

userLoginName -

workflowInstanceId -

taskName -

Returns:

List

getHistoricTasks

public static java.util.List<org.activiti.engine.history.HistoricActivityInstance> getHistoricTasks(java.lang.String userLoginName,
                                                                                                    java.lang.String workflowInstanceId,
                                                                                                    java.lang.String taskName,
                                                                                                    int limit)

Fetches a list of size @param limit of the HistoricActivityInstances that match the included parameters. If a parameter is left blank it is not included in the query and will be ignored Orders results from newest to oldest

Parameters:

userLoginName -

workflowInstanceId -

taskName -

limit -

Returns:

List

activitiTaskToOCTaskInstance

public static TaskInstance activitiTaskToOCTaskInstance(org.activiti.engine.task.Task actTask,
                                                        java.util.Map actTaskVariables,
                                                        java.lang.String ticket,
                                                        org.activiti.engine.TaskService taskService,
                                                        org.activiti.engine.RepositoryService repositoryService)

activitiTasksToOCTaskInstances

public static java.util.List<TaskInstance> activitiTasksToOCTaskInstances(java.util.List<org.activiti.engine.task.Task> tasks,
                                                                          java.lang.String ticket,
                                                                          org.activiti.engine.TaskService taskService,
                                                                          org.activiti.engine.RepositoryService repositoryService)

activitiProcessInstanceToOCWorkflowInstance

public static WorkflowInstance activitiProcessInstanceToOCWorkflowInstance(java.lang.String ticket,
                                                                           org.activiti.engine.runtime.ProcessInstance pi)

activitiProcessInstancesToOCWorkflowInstances

public static java.util.List<WorkflowInstance> activitiProcessInstancesToOCWorkflowInstances(java.lang.String ticket,
                                                                                             java.util.List<org.activiti.engine.runtime.ProcessInstance> instances)

createWorkflowSnapshotInstance

public static WorkflowInstanceSnapshot createWorkflowSnapshotInstance(java.lang.String ticket,
                                                                      WorkflowInstance workflowInstance,
                                                                      java.util.List<TaskInstance> taskInstances)

getMapVariable

public static java.util.Map<java.lang.String,java.lang.Object> getMapVariable(java.util.Map<java.lang.String,java.lang.Object> variables,
                                                                              java.lang.String variableKey)

Retrieves an Activiti variable in the variable map as a Map. Code that has access to the variable map, but needs to get one of the map values as a Map should use this method to get the sanitized map value.

Parameters:

variables -

variableKey -

Returns:

See Also:

sanitizeMapForActivitiVariable(Map)

getMapVariable

public static java.util.Map<java.lang.String,java.lang.Object> getMapVariable(org.activiti.engine.delegate.DelegateTask task,
                                                                              java.lang.String variableKey)

Retrieves an Activity variable from the given DelegateTask as a Map. Code that has a DelegateTask and needs to get one of the variable values as a Map should use this method to get the sanitized map value.

Parameters:

task -

variableKey -

Returns:

See Also:

sanitizeMapForActivitiVariable(Map)

getListOfMapsVariable

public static java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getListOfMapsVariable(org.activiti.engine.delegate.DelegateTask task,
                                                                                                     java.lang.String variableKey)

Retrieves an Activity variable from the given DelegateTask as a List of Maps. Code that has a DelegateTask and needs to get one of the variable values as a List of Maps should use this method to get the sanitized map value.

Parameters:

task -

variableKey -

Returns:

See Also:

sanitizeMapForActivitiVariable(Map)

setMapVariable

public static void setMapVariable(org.activiti.engine.delegate.DelegateTask task,
                                  java.lang.String variableKey,
                                  java.util.Map<java.lang.String,java.lang.Object> value,
                                  boolean isLocal)

Sets a Map variable into the given DelegateTask.

Parameters:

task -

variableKey -

value -

isLocal - if true the VariableScope.setVariableLocal(String, Object) method is used. Otherwise, VariableScope.setVariable(String, Object) is used.

See Also:

sanitizeMapForActivitiVariable(Map)

sanitizeMapForActivitiVariable

public static byte[] sanitizeMapForActivitiVariable(java.util.Map<java.lang.String,java.lang.Object> map)

Activiti cannot handle storing a HashMap into a worflow variable. See http://forums.activiti.org/content/activiti-process-variable-version-and-optimistic-locking-exception for more information. This method sanitizes the Map as a JSON string, converted to a byte[] that can be written safely to the variable. By default, Jackson uses UTF-8 as the character encoding for the byte[].

Parameters:

map -

Returns:

setAssigneeDecisionVariables

public static void setAssigneeDecisionVariables(org.activiti.engine.delegate.DelegateExecution execution)

Helper function to set the groupAssigneeExists and individualAssigneeExists execution variables based on if the standard assignee variables are set. Moved here from CompleteTaskActionExecuter because they are not 100% generic properties, but can still be reused by workflow definitions that accept user or group assignees.

Parameters:

execution - The workflow execution

addAssigneesToModelFromExecution

public static java.util.Map<java.lang.String,java.lang.Object> addAssigneesToModelFromExecution(org.activiti.engine.delegate.DelegateExecution execution,
                                                                                                java.util.Map<java.lang.String,java.lang.Object> model)

This will add the standard workflow bpm_assignees and bpm_groupAssignee to any model that adheres to the Map format

Parameters:

execution - Activiti execution instance

model - The map that the assignee value(s) will be added to

Returns:

model Map

getAssigneesFromParam

public static java.util.List<java.lang.String> getAssigneesFromParam(java.lang.Object assigneesParam)

The assigneesParam can either be a List or a String. This method normalizes the param to a List so that the code can work with it generically

Parameters:

assigneesParam - the assignees param

Returns:

the assignees as a List

copyExecutionDueDateToTaskDueDate

public static void copyExecutionDueDateToTaskDueDate(org.activiti.engine.delegate.DelegateTask task)

Method that copies the workflow execution due date (bpm_workflowDueDate) to the task due date.

Parameters:

task - The workflow task

copyTaskDueDateToExecutionDueDate

public static void copyTaskDueDateToExecutionDueDate(org.activiti.engine.delegate.DelegateTask task)

Method that copies the bpm_workflowDueDate property on the task up to the workflow execution due date.

Parameters:

task - The workflow task