com.tsgrp.opencontent.activiti.workflow

Class ActivitiWorkflowImpl

java.lang.Object

com.tsgrp.opencontent.activiti.workflow.ActivitiWorkflowImpl

All Implemented Interfaces:

IWorkflow

Direct Known Subclasses:

ActivitiAlfrescoWorkflowImpl, ActivitiDctmWorkflowImpl

public class ActivitiWorkflowImpl
extends java.lang.Object
implements IWorkflow

This is where our activiti specific code lives. Activiti classes and concepts are not to be exposed outside of this and other activiti implementation classes. Instead, make sure to honor the javadoc'ed contracts specified in the IWorkflow interface methods.

Constructor Summary

Constructors

Constructor and Description
ActivitiWorkflowImpl()

Method Summary

Modifier and Type	Method and Description
java.util.List<WorkflowInstance>	abortOrphanedWorkflows(java.lang.String ticket) Abort the workflows in the system that are orphaned.
void	acquireTask(java.lang.String ticket, java.lang.String taskId) Throws a runtime exception if the task already belongs to a user.
boolean	addTaskAssignee(java.lang.String ticket, java.lang.String taskId, java.lang.String userLoginName)
java.lang.String	buildWorkflowPackage(java.lang.String ticket, java.lang.String[] packageItemIds)
void	cancelWorkflow(java.lang.String ticket, java.lang.String workflowInstanceId, java.lang.String deleteReason) Terminates the specified workflow.
boolean	completeTask(java.lang.String ticket, java.lang.String taskId, java.util.Map<java.lang.String,java.lang.Object> props)
void	deleteWorkflowDefinitionDeployment(java.lang.String ticket, java.lang.String deploymentId)
java.lang.String	deployWorkflowDefinitionOnClasspath(java.lang.String ticket, java.lang.String wfDefFileNameOnClasspath) Deploys a workflow definition that is present on the classpath.
java.util.List<WorkflowInstance>	getAllWorkflowInstances(java.lang.String ticket) Return a list of all WorkflowInstance objects in the system.
java.util.List<WorkflowInstanceSnapshot>	getAllWorkflowInstanceSnapshots(java.lang.String ticket) Returns a list of ALL in-flight workflow processes regardless of their initiator
java.util.List<WorkflowInstanceSnapshot>	getAllWorkflowInstanceSnapshotsByGroup(java.lang.String ticket, java.util.List<java.lang.String> groups) Returns a list of WorkflowInstanceSnapshot objects with tasks assigned to a group in groups
java.util.List<java.lang.String>	getCandidateGroups(java.lang.String ticket, java.lang.String taskId)
java.util.List<java.lang.String>	getCandidateUsers(java.lang.String ticket, java.lang.String taskId)
java.lang.String	getInboxProxyUser(java.lang.String ticket, java.lang.String userLoginName)
java.util.List<WorkflowInstance>	getOrphanedWorkflows(java.lang.String ticket) Return a list of workflows that are orphaned.
java.util.Map<java.lang.String,java.lang.Object>	getStartForm(java.lang.String ticket, java.lang.String processDefinitionId) Get the Start Form key for an Activiti Workflow
TaskInstance	getTask(java.lang.String ticket, java.lang.String taskId) TODO document
java.util.List<java.lang.String>	getTaskAssignees(java.lang.String ticket, java.lang.String taskId)
java.util.List<java.lang.String>	getTaskIdsForContent(java.lang.String ticket, java.lang.String nodeId) Returns list of task ids of workflows in which nodeId is part of a WorkflowPackage
java.util.List<TaskInstance>	getTasks(java.lang.String ticket, java.lang.String userLoginName, java.lang.String workflowInstanceId, java.lang.String taskName) Returns a list of OC Workflow TaskInstances, narrowed down by parameters.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getTasksForProcess(java.lang.String ticket, java.lang.String processDefinitionId) Returns a list of all tasks available for a Process Definition (Workflow) WARNING: This is using internal Activiti classes right now: https://forums.activiti.org/content/gettaskdesfinitionlist
protected java.util.List<org.activiti.engine.task.Task>	getUnclaimedActivitiTasks(java.lang.String ticket, java.lang.String userLoginName, java.lang.String workflowInstanceId)
java.util.List<TaskInstance>	getUnclaimedTasks(java.lang.String ticket, java.lang.String userLoginName, java.lang.String workflowInstanceId) Returns a list of OC Workflow TaskInstances, narrowed down by parameters.
java.lang.String	getWorkflowDefinitionId(java.lang.String ticket, java.lang.String processId) Returns the workflow definition id that the specified workflow instance id is an instance of.
java.util.List<WorkflowDefinition>	getWorkflowDefinitions(java.lang.String ticket)
WorkflowInstance	getWorkflowInstance(java.lang.String ticket, java.lang.String workflowInstanceId) Returns the workflow instance for the given instance id.
java.lang.String	getWorkflowInstanceIdFromTaskId(java.lang.String ticket, java.lang.String taskId) Returns the workflow instance id that the specified taskId belongs to.
java.util.List<java.lang.String>	getWorkflowInstanceIdsForContent(java.lang.String ticket, java.lang.String nodeId) Returns the workflowInstanceIds of any workflows that nodeId is part of a WorkflowPackage in.
java.util.List<WorkflowInstanceSnapshot>	getWorkflowInstanceSnapshots(java.lang.String ticket, java.lang.String userLoginName, int numPerPage) Returns a list of OC workflowInstanceSnapshot objects representing workflows initiated by @userLoginName
WorkflowPackage	getWorkflowPackageByPackageId(java.lang.String ticket, java.lang.String wfPackageId)
WorkflowPackage	getWorkflowPackageByTaskId(java.lang.String ticket, java.lang.String taskId)
WorkflowPackage	getWorkflowPackageByWorkflowInstanceId(java.lang.String ticket, java.lang.String workflowInstanceId, boolean loadPackageObjects)
protected WorkflowPackage	getWorkflowPackageByWorkflowInstanceId(java.lang.String ticket, java.lang.String workflowInstanceId, boolean loadPackageObjects, org.activiti.engine.RuntimeService runtimeService)
boolean	processWorkflowPackage(java.lang.String ticket, java.lang.String workflowInstanceId, java.lang.String workflowPackageId)
void	releaseTask(java.lang.String ticket, java.lang.String taskId, boolean canReleaseAnotherUsersTask) If canReleaseAnotherUsersTask is set to true, a user can release a task that is assigned to another user.
boolean	removeTaskAssignee(java.lang.String ticket, java.lang.String taskId, java.lang.String userLoginName)
boolean	setExecutionVariable(java.lang.String ticket, java.lang.String processInstanceId, java.lang.String variable, java.lang.Object variableValue)
protected void	setOCTicketOnExecutionScope(java.lang.String ticket, java.lang.String processInstanceId, org.activiti.engine.ProcessEngine processEngine)
protected void	setOCTicketOnExecutionScopeFromTask(java.lang.String ticket, java.lang.String taskId, org.activiti.engine.ProcessEngine processEngine) May throw an exception if there is no execution scope for the parameterized taskId.
boolean	setTaskAssignee(java.lang.String ticket, java.lang.String taskId, java.lang.String userLoginName, java.util.Map<java.lang.String,java.lang.String> props) Sets the specified user as the assignee of the specified task.
boolean	setTaskStatus(java.lang.String ticket, java.lang.String taskId, java.lang.String status)
void	setWorkflowPackage(java.lang.String ticket, java.lang.String workflowInstanceId, WorkflowPackage workflowPackage)
java.lang.String	startWorkflow(java.lang.String ticket, java.lang.String workflowDefinitionId, java.util.Map props) Starts a new instance of the specified workflow.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivitiWorkflowImpl

public ActivitiWorkflowImpl()

Method Detail

getTasks

public java.util.List<TaskInstance> getTasks(java.lang.String ticket,
                                             java.lang.String userLoginName,
                                             java.lang.String workflowInstanceId,
                                             java.lang.String taskName)

Description copied from interface: IWorkflow

Returns a list of OC Workflow TaskInstances, narrowed down by parameters. All parameters can be null unless specified. Active Wizard tasks are filtered.

Specified by:

getTasks in interface IWorkflow

userLoginName - - user whose assigned tasks are returned. if null, returns all tasks unrestricted by user.

workflowInstanceId - - The id of the workflow instance, optional.

taskName - - The name/type of task to return, optional.

Returns:

getUnclaimedTasks

public java.util.List<TaskInstance> getUnclaimedTasks(java.lang.String ticket,
                                                      java.lang.String userLoginName,
                                                      java.lang.String workflowInstanceId)

Description copied from interface: IWorkflow

Returns a list of OC Workflow TaskInstances, narrowed down by parameters. All parameters can be null unless specified.

Specified by:

getUnclaimedTasks in interface IWorkflow

userLoginName - - user whose assigned tasks are returned. if null, returns all tasks unrestricted by user.

Returns:

getUnclaimedActivitiTasks

protected java.util.List<org.activiti.engine.task.Task> getUnclaimedActivitiTasks(java.lang.String ticket,
                                                                                  java.lang.String userLoginName,
                                                                                  java.lang.String workflowInstanceId)

getTask

public TaskInstance getTask(java.lang.String ticket,
                            java.lang.String taskId)

Description copied from interface: IWorkflow

TODO document

Specified by:

getTask in interface IWorkflow

Returns:

getWorkflowInstanceIdFromTaskId

public java.lang.String getWorkflowInstanceIdFromTaskId(java.lang.String ticket,
                                                        java.lang.String taskId)

Returns the workflow instance id that the specified taskId belongs to.

Specified by:

getWorkflowInstanceIdFromTaskId in interface IWorkflow

Parameters:

ticket -

taskId -

Returns:

getWorkflowInstance

public WorkflowInstance getWorkflowInstance(java.lang.String ticket,
                                            java.lang.String workflowInstanceId)

Description copied from interface: IWorkflow

Returns the workflow instance for the given instance id. If no workflow is found, this method returns null.

Specified by:

getWorkflowInstance in interface IWorkflow

Returns:

getWorkflowDefinitionId

public java.lang.String getWorkflowDefinitionId(java.lang.String ticket,
                                                java.lang.String processId)

Description copied from interface: IWorkflow

Returns the workflow definition id that the specified workflow instance id is an instance of.

Specified by:

getWorkflowDefinitionId in interface IWorkflow

Returns:

setTaskAssignee

public boolean setTaskAssignee(java.lang.String ticket,
                               java.lang.String taskId,
                               java.lang.String userLoginName,
                               java.util.Map<java.lang.String,java.lang.String> props)

Description copied from interface: IWorkflow

Sets the specified user as the assignee of the specified task. NOTE: Will override any previously assigned user(s)!

Specified by:

setTaskAssignee in interface IWorkflow

Returns:

setTaskStatus

public boolean setTaskStatus(java.lang.String ticket,
                             java.lang.String taskId,
                             java.lang.String status)

Specified by:

setTaskStatus in interface IWorkflow

startWorkflow

public java.lang.String startWorkflow(java.lang.String ticket,
                                      java.lang.String workflowDefinitionId,
                                      java.util.Map props)

Description copied from interface: IWorkflow

Starts a new instance of the specified workflow.

Specified by:

startWorkflow in interface IWorkflow

Returns:

new workflowInstanceId

buildWorkflowPackage

public java.lang.String buildWorkflowPackage(java.lang.String ticket,
                                             java.lang.String[] packageItemIds)

Specified by:

buildWorkflowPackage in interface IWorkflow

processWorkflowPackage

public boolean processWorkflowPackage(java.lang.String ticket,
                                      java.lang.String workflowInstanceId,
                                      java.lang.String workflowPackageId)

Specified by:

processWorkflowPackage in interface IWorkflow

getWorkflowPackageByTaskId

public WorkflowPackage getWorkflowPackageByTaskId(java.lang.String ticket,
                                                  java.lang.String taskId)

Specified by:

getWorkflowPackageByTaskId in interface IWorkflow

getWorkflowPackageByPackageId

public WorkflowPackage getWorkflowPackageByPackageId(java.lang.String ticket,
                                                     java.lang.String wfPackageId)

Specified by:

getWorkflowPackageByPackageId in interface IWorkflow

getWorkflowPackageByWorkflowInstanceId

public WorkflowPackage getWorkflowPackageByWorkflowInstanceId(java.lang.String ticket,
                                                              java.lang.String workflowInstanceId,
                                                              boolean loadPackageObjects)

Specified by:

getWorkflowPackageByWorkflowInstanceId in interface IWorkflow

getWorkflowPackageByWorkflowInstanceId

protected WorkflowPackage getWorkflowPackageByWorkflowInstanceId(java.lang.String ticket,
                                                                 java.lang.String workflowInstanceId,
                                                                 boolean loadPackageObjects,
                                                                 org.activiti.engine.RuntimeService runtimeService)

setWorkflowPackage

public void setWorkflowPackage(java.lang.String ticket,
                               java.lang.String workflowInstanceId,
                               WorkflowPackage workflowPackage)

Specified by:

setWorkflowPackage in interface IWorkflow

completeTask

public boolean completeTask(java.lang.String ticket,
                            java.lang.String taskId,
                            java.util.Map<java.lang.String,java.lang.Object> props)

Specified by:

completeTask in interface IWorkflow

acquireTask

public void acquireTask(java.lang.String ticket,
                        java.lang.String taskId)

Description copied from interface: IWorkflow

Throws a runtime exception if the task already belongs to a user.

Specified by:

acquireTask in interface IWorkflow

releaseTask

public void releaseTask(java.lang.String ticket,
                        java.lang.String taskId,
                        boolean canReleaseAnotherUsersTask)

Description copied from interface: IWorkflow

If canReleaseAnotherUsersTask is set to true, a user can release a task that is assigned to another user. Otherwise, a user can only release his or her own task and throws a runtime exception if the task does not belong to the user.

Specified by:

releaseTask in interface IWorkflow

taskId - - String representing the task's id

canReleaseAnotherUsersTask - - boolean for if another user's acquired task can be released by user

cancelWorkflow

public void cancelWorkflow(java.lang.String ticket,
                           java.lang.String workflowInstanceId,
                           java.lang.String deleteReason)

Description copied from interface: IWorkflow

Terminates the specified workflow.

Specified by:

cancelWorkflow in interface IWorkflow

deployWorkflowDefinitionOnClasspath

public java.lang.String deployWorkflowDefinitionOnClasspath(java.lang.String ticket,
                                                            java.lang.String wfDefFileNameOnClasspath)

Description copied from interface: IWorkflow

Deploys a workflow definition that is present on the classpath.

If the specified workflow definition is already deployed, returns the deployment id of that deployment, and does NOT try to redeploy the workflow definition.

Specified by:

deployWorkflowDefinitionOnClasspath in interface IWorkflow

Returns:

the deployment id

deleteWorkflowDefinitionDeployment

public void deleteWorkflowDefinitionDeployment(java.lang.String ticket,
                                               java.lang.String deploymentId)

Specified by:

deleteWorkflowDefinitionDeployment in interface IWorkflow

getCandidateUsers

public java.util.List<java.lang.String> getCandidateUsers(java.lang.String ticket,
                                                          java.lang.String taskId)

Specified by:

getCandidateUsers in interface IWorkflow

getCandidateGroups

public java.util.List<java.lang.String> getCandidateGroups(java.lang.String ticket,
                                                           java.lang.String taskId)

Specified by:

getCandidateGroups in interface IWorkflow

getWorkflowInstanceIdsForContent

public java.util.List<java.lang.String> getWorkflowInstanceIdsForContent(java.lang.String ticket,
                                                                         java.lang.String nodeId)

Description copied from interface: IWorkflow

Returns the workflowInstanceIds of any workflows that nodeId is part of a WorkflowPackage in.

Specified by:

getWorkflowInstanceIdsForContent in interface IWorkflow

Returns:

a non null array of strings, workflowInstanceIds

getTaskIdsForContent

public java.util.List<java.lang.String> getTaskIdsForContent(java.lang.String ticket,
                                                             java.lang.String nodeId)

Description copied from interface: IWorkflow

Returns list of task ids of workflows in which nodeId is part of a WorkflowPackage

Specified by:

getTaskIdsForContent in interface IWorkflow

Returns:

list of taskIds

getTaskAssignees

public java.util.List<java.lang.String> getTaskAssignees(java.lang.String ticket,
                                                         java.lang.String taskId)

Specified by:

getTaskAssignees in interface IWorkflow

addTaskAssignee

public boolean addTaskAssignee(java.lang.String ticket,
                               java.lang.String taskId,
                               java.lang.String userLoginName)

Specified by:

addTaskAssignee in interface IWorkflow

removeTaskAssignee

public boolean removeTaskAssignee(java.lang.String ticket,
                                  java.lang.String taskId,
                                  java.lang.String userLoginName)

Specified by:

removeTaskAssignee in interface IWorkflow

setExecutionVariable

public boolean setExecutionVariable(java.lang.String ticket,
                                    java.lang.String processInstanceId,
                                    java.lang.String variable,
                                    java.lang.Object variableValue)

Specified by:

setExecutionVariable in interface IWorkflow

setOCTicketOnExecutionScopeFromTask

protected void setOCTicketOnExecutionScopeFromTask(java.lang.String ticket,
                                                   java.lang.String taskId,
                                                   org.activiti.engine.ProcessEngine processEngine)
                                            throws java.lang.Exception

May throw an exception if there is no execution scope for the parameterized taskId.

Parameters:

ticket -

taskId -

Throws:

java.lang.Exception

setOCTicketOnExecutionScope

protected void setOCTicketOnExecutionScope(java.lang.String ticket,
                                           java.lang.String processInstanceId,
                                           org.activiti.engine.ProcessEngine processEngine)

getWorkflowInstanceSnapshots

public java.util.List<WorkflowInstanceSnapshot> getWorkflowInstanceSnapshots(java.lang.String ticket,
                                                                             java.lang.String userLoginName,
                                                                             int numPerPage)

Description copied from interface: IWorkflow

Returns a list of OC workflowInstanceSnapshot objects representing workflows initiated by @userLoginName

Specified by:

getWorkflowInstanceSnapshots in interface IWorkflow

Returns:

list of WorkflowInstanceSnapshots objects

getInboxProxyUser

public java.lang.String getInboxProxyUser(java.lang.String ticket,
                                          java.lang.String userLoginName)

Specified by:

getInboxProxyUser in interface IWorkflow

getWorkflowDefinitions

public java.util.List<WorkflowDefinition> getWorkflowDefinitions(java.lang.String ticket)

Specified by:

getWorkflowDefinitions in interface IWorkflow

getAllWorkflowInstanceSnapshots

public java.util.List<WorkflowInstanceSnapshot> getAllWorkflowInstanceSnapshots(java.lang.String ticket)

Description copied from interface: IWorkflow

Returns a list of ALL in-flight workflow processes regardless of their initiator

Specified by:

getAllWorkflowInstanceSnapshots in interface IWorkflow

Parameters:

ticket - valid OC ticket

Returns:

list of all in-flight workflow processes

getAllWorkflowInstanceSnapshotsByGroup

public java.util.List<WorkflowInstanceSnapshot> getAllWorkflowInstanceSnapshotsByGroup(java.lang.String ticket,
                                                                                       java.util.List<java.lang.String> groups)

Description copied from interface: IWorkflow

Returns a list of WorkflowInstanceSnapshot objects with tasks assigned to a group in groups

Specified by:

getAllWorkflowInstanceSnapshotsByGroup in interface IWorkflow

groups - - list of strings of group names

Returns:

list of workflow instance snapshots by group

getAllWorkflowInstances

public java.util.List<WorkflowInstance> getAllWorkflowInstances(java.lang.String ticket)

Description copied from interface: IWorkflow

Return a list of all WorkflowInstance objects in the system. Note that Active Wizard approval routes will actually have two items in the list for one "workflow". This is because the main process and the subprocess each are contained in this list. Additionally, implementations should be careful to ensure that the calling user is an administrator and capable of viewing all documents.

Specified by:

getAllWorkflowInstances in interface IWorkflow

Parameters:

ticket - the OC ticket

Returns:

List containing all WorkflowInstance objects in the system

getOrphanedWorkflows

public java.util.List<WorkflowInstance> getOrphanedWorkflows(java.lang.String ticket)

Description copied from interface: IWorkflow

Return a list of workflows that are orphaned. Orphaned workflows are defined as any workflow that has workflow packages that no longer exist in the ECM repository. If a workflow has more than one package, all package items must be missing in order for the workflow to be orphaned. Additionally, implementations should be careful to ensure that the calling user is an administrator and capable of viewing all documents. In other words, you don't want to include a workflow in this list simply becuase the user does not have permissions to view the attached documents.

Specified by:

getOrphanedWorkflows in interface IWorkflow

Parameters:

ticket - valid OC ticket

Returns:

List containing the orphaned workflows, or an empty list if there are none.

See Also:

IUser.isAuthenticatedUserAdmin(String)

abortOrphanedWorkflows

public java.util.List<WorkflowInstance> abortOrphanedWorkflows(java.lang.String ticket)

Description copied from interface: IWorkflow

Abort the workflows in the system that are orphaned. See IWorkflow.getOrphanedWorkflows(String) for what constitutes an orphaned workflow. Before calling this method, it may be a good idea to first list out the orphaned workflows to ensure you do not end up aborting workflows that should not be.

Specified by:

abortOrphanedWorkflows in interface IWorkflow

Parameters:

ticket - valid OC ticket

Returns:

List containing the orphaned workflows that were deleted, or an empty list if there are none.

See Also:

IUser.isAuthenticatedUserAdmin(String), IWorkflow.getOrphanedWorkflows(String)

getTasksForProcess

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getTasksForProcess(java.lang.String ticket,
                                                                                           java.lang.String processDefinitionId)

Description copied from interface: IWorkflow

Returns a list of all tasks available for a Process Definition (Workflow) WARNING: This is using internal Activiti classes right now: https://forums.activiti.org/content/gettaskdesfinitionlist

Specified by:

getTasksForProcess in interface IWorkflow

getStartForm

public java.util.Map<java.lang.String,java.lang.Object> getStartForm(java.lang.String ticket,
                                                                     java.lang.String processDefinitionId)
                                                              throws OCException

Description copied from interface: IWorkflow

Get the Start Form key for an Activiti Workflow

Specified by:

getStartForm in interface IWorkflow

processDefinitionId - base Activiti Workflow Definition name such as activitiReview - see bpmn.xml for the configured names

Returns:

start form key for the passed in Workflow Definition

Throws:

OCException