Package com.vdoc.sdk.commons.utils

Class WorkflowInstanceUtils

java.lang.Object

com.vdoc.sdk.commons.utils.WorkflowInstanceUtils

public class WorkflowInstanceUtils
extends Object

A VDoc tool class for IWorkflowInstance.

Since:

1.9

Author:

famaridon

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WorkflowInstanceUtils.DelegationMode	this enum contains how to build past actors set when step is delegated.

Method Summary

Modifier and Type	Method	Description
static IWorkflowInstance	createLinkedWorkflowInstance(IContext context, IWorkflowInstance parentWorkflowInstance, IWorkflowContainer workflowContainer, String fieldName)	Create a linked workflowinstance for a workflowinstance and save it in a field
static void	endTaskInstance(IWorkflowModule workflowModule, IWorkflowInstance workflowInstance, String actionName, IUser actor, String comment)	end the current ITaskInstance.
static void	endTaskInstanceWithFirstOperator(IWorkflowModule workflowModule, IWorkflowInstance workflowInstance, String actionName)	same as endTaskInstanceWithFirstOperator(IWorkflowModule, IWorkflowInstance, String, String) without comment
static void	endTaskInstanceWithFirstOperator(IWorkflowModule workflowModule, IWorkflowInstance workflowInstance, String actionName, String comment)	with actor = null and comment = "WorkflowHelper.endTaskInstance"
static void	endTaskInstanceWithUser(IWorkflowModule workflowModule, IWorkflowInstance workflowInstance, String actionName, IUser actor)	same as endTaskInstanceWithUser(com.axemble.vdoc.sdk.modules.IWorkflowModule, com.axemble.vdoc.sdk.interfaces.IWorkflowInstance, java.lang.String, com.axemble.vdoc.sdk.interfaces.IUser, java.lang.String) with no comment.
static void	endTaskInstanceWithUser(IWorkflowModule workflowModule, IWorkflowInstance workflowInstance, String actionName, IUser actor, String comment)	same as endTaskInstance(com.axemble.vdoc.sdk.modules.IWorkflowModule, com.axemble.vdoc.sdk.interfaces.IWorkflowInstance, java.lang.String, com.axemble.vdoc.sdk.interfaces.IUser, java.lang.String) but actor is mandatory.
static Set<IUser>	getAllPastActors(IWorkflowInstance workflowInstance)	call getAllPastActors(IWorkflowInstance, DelegationMode) with the default WorkflowInstanceUtils.DelegationMode ( WorkflowInstanceUtils.DelegationMode.ADDRESSEE_AND_FULFILLER )
static Set<IUser>	getAllPastActors(IWorkflowInstance workflowInstance, WorkflowInstanceUtils.DelegationMode delegationMode)	get all IWorkflowInstance's past actors based on IHistory.
static IWorkflowInstance	getWorkflowInstance(IWorkflowModule workflowModule, IResource resource)	getWorkflowInstance

Methods inherited from class java.lang.Object

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

Method Details

getAllPastActors

public static Set<IUser> getAllPastActors(IWorkflowInstance workflowInstance)

call getAllPastActors(IWorkflowInstance, DelegationMode) with the default WorkflowInstanceUtils.DelegationMode ( WorkflowInstanceUtils.DelegationMode.ADDRESSEE_AND_FULFILLER )

Parameters:

workflowInstance - the IWorkflowInstance whose you want get all past actors

Returns:

a Set with all past actors

getAllPastActors

public static Set<IUser> getAllPastActors(IWorkflowInstance workflowInstance,
 WorkflowInstanceUtils.DelegationMode delegationMode)

get all IWorkflowInstance's past actors based on IHistory.

Parameters:

workflowInstance - workflowInstance the IWorkflowInstance whose you want get all past actors

delegationMode - the method used to build the output Set when a IResourceHistory.IEvent's fulfiller is not the addressee

Returns:

a Set with all past actors

createLinkedWorkflowInstance

public static IWorkflowInstance createLinkedWorkflowInstance(IContext context,
 IWorkflowInstance parentWorkflowInstance,
 IWorkflowContainer workflowContainer,
 String fieldName)
                                                      throws WorkflowModuleException

Create a linked workflowinstance for a workflowinstance and save it in a field

Parameters:

context - context for creator of the linked workflowinstance

parentWorkflowInstance - the workflowinstance parent

workflowContainer - the workflowContainer of the linked workflowinstance

fieldName - the field of the parent

Returns:

IWorkflowInstance

Throws:

WorkflowModuleException - Workflow Module Exception

endTaskInstance

public static void endTaskInstance(IWorkflowModule workflowModule,
 IWorkflowInstance workflowInstance,
 String actionName,
 IUser actor,
 String comment)
                            throws WorkflowModuleException

end the current ITaskInstance.

Parameters:

workflowModule - an init IWorkflowModule

workflowInstance - the IWorkflowInstance to end current ITaskInstance

actionName - the action system name

actor - IUser will be used to end task. (nullable : if null the first operator is used)

comment - the history comment. (nullable : if null empty string is used)

Throws:

WorkflowModuleException - Workflow Module Exception

IllegalArgumentException - if the IWorkflowInstance have not started task instance or is in parallelism state

endTaskInstanceWithUser

public static void endTaskInstanceWithUser(IWorkflowModule workflowModule,
 IWorkflowInstance workflowInstance,
 String actionName,
 IUser actor,
 String comment)
                                    throws WorkflowModuleException

same as endTaskInstance(com.axemble.vdoc.sdk.modules.IWorkflowModule, com.axemble.vdoc.sdk.interfaces.IWorkflowInstance, java.lang.String, com.axemble.vdoc.sdk.interfaces.IUser, java.lang.String) but actor is mandatory.

Parameters:

workflowModule - an init IWorkflowModule

workflowInstance - the IWorkflowInstance to end current ITaskInstance

actionName - the action system name

actor - IUser will be used to end task.

comment - the history comment. (nullable : if null empty string is used)

Throws:

WorkflowModuleException - Workflow Module Exception

endTaskInstanceWithUser

public static void endTaskInstanceWithUser(IWorkflowModule workflowModule,
 IWorkflowInstance workflowInstance,
 String actionName,
 IUser actor)
                                    throws WorkflowModuleException

same as endTaskInstanceWithUser(com.axemble.vdoc.sdk.modules.IWorkflowModule, com.axemble.vdoc.sdk.interfaces.IWorkflowInstance, java.lang.String, com.axemble.vdoc.sdk.interfaces.IUser, java.lang.String) with no comment.

Parameters:

workflowModule - an init IWorkflowModule

workflowInstance - the IWorkflowInstance to end current ITaskInstance

actionName - the action system name

actor - IUser will be used to end task.

Throws:

WorkflowModuleException - Workflow Module Exception

endTaskInstanceWithFirstOperator

public static void endTaskInstanceWithFirstOperator(IWorkflowModule workflowModule,
 IWorkflowInstance workflowInstance,
 String actionName)
                                             throws WorkflowModuleException

same as endTaskInstanceWithFirstOperator(IWorkflowModule, IWorkflowInstance, String, String) without comment

Parameters:

workflowModule - an init IWorkflowModule

workflowInstance - the IWorkflowInstance to end current ITaskInstance

actionName - the action system name

Throws:

WorkflowModuleException - Workflow Module Exception

IllegalArgumentException - if the IWorkflowInstance have not started task instance or is in parallelism state

endTaskInstanceWithFirstOperator

public static void endTaskInstanceWithFirstOperator(IWorkflowModule workflowModule,
 IWorkflowInstance workflowInstance,
 String actionName,
 String comment)
                                             throws WorkflowModuleException

with actor = null and comment = "WorkflowHelper.endTaskInstance"

Parameters:

workflowModule - an init IWorkflowModule

workflowInstance - the IWorkflowInstance to end current ITaskInstance

actionName - the action system name

comment - the history comment. (nullable : if null empty string is used)

Throws:

WorkflowModuleException - Workflow Module Exception

IllegalArgumentException - if the IWorkflowInstance have not started task instance or is in parallelism state

getWorkflowInstance

public static IWorkflowInstance getWorkflowInstance(IWorkflowModule workflowModule,
 IResource resource)

getWorkflowInstance

Parameters:

workflowModule - IWorkflowModule

resource - IResource

Returns:

IWorkflowInstance