|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RuntimeAPI
To manage process, process instance and task life cycle operations as well as to set/add/update variables within activity or instance. Default states for process, processes instances, tasks (aka manual activities) are:
States for process
: UNDEPLOYED, DEPLOYEDStates for process instance
: INITIAL, STARTED, FINISHEDStates for task
: INITIAL, READY, EXECUTING, SUSPENDED, FINISHED
TxHook
Method Summary | |
---|---|
void |
addComment(ProcessInstanceUUID instanceUUID,
ActivityInstanceUUID activityUUID,
java.lang.String message,
java.lang.String userId)
Add a comment to the ProcessInstance feed. |
void |
addProcessMetaData(ProcessDefinitionUUID uuid,
java.lang.String key,
java.lang.String value)
Add a process meta data. |
void |
assignTask(TaskUUID taskUUID)
Launches the execution of both roleMapper and performerAssignment for the given task. If a roleMapper has been defined within the participant referenced by the performer of the task, it is executed. If a performerAssignment has been defined within the activity of the task it is also executed. |
void |
assignTask(TaskUUID taskUUID,
java.util.Set<java.lang.String> candidates)
Forces to replace the candidates set of the given task by the given candidates set. |
void |
assignTask(TaskUUID taskUUID,
java.lang.String actorId)
Forces to assign the given task to the given actor id. |
void |
cancelProcessInstance(ProcessInstanceUUID instanceUUID)
Cancel the process instance with the given instance UUID. |
void |
deleteAllProcessInstances(ProcessDefinitionUUID processUUID)
Deletes all runtime objects for all instances created with the given process UUID and delete also all there recorded data from the journal. |
void |
deleteProcessInstance(ProcessInstanceUUID instanceUUID)
Deletes all runtime objects for the process instance with the given instance UUID and delete also recorded data from the journal. |
void |
deleteProcessMetaData(ProcessDefinitionUUID uuid,
java.lang.String key)
Delete a process meta data. |
java.lang.Object |
evaluateGroovyExpression(java.lang.String expression,
ActivityInstanceUUID activityUUID)
Evaluates an expression using Groovy. |
java.lang.Object |
evaluateGroovyExpression(java.lang.String expression,
ProcessInstanceUUID instanceUUID)
Evaluates an expression using Groovy. |
void |
finishTask(TaskUUID taskUUID,
boolean taskAssign)
Finishes the task. |
ProcessInstanceUUID |
instantiateProcess(ProcessDefinitionUUID processUUID)
Creates an instance of the specified process and start the execution. |
ProcessInstanceUUID |
instantiateProcess(ProcessDefinitionUUID processUUID,
java.util.Map<java.lang.String,java.lang.Object> variables)
Creates an instance of the specified process with the added variable map and start the execution. |
void |
resumeTask(TaskUUID taskUUID,
boolean taskAssign)
Resumes the task if the task has SUSPENDED state. |
void |
setActivityInstanceVariable(ActivityInstanceUUID activityUUID,
java.lang.String variableId,
java.lang.Object variableValue)
Searches for variable with the given activity UUID and variable Id. If the activity variable is found, the given value is set. If the XPDL dataField has String type then use instance of java.lang.String class for variableValue. If the XPDL dataField has EnumerationType type then use instance of Enumeration class for variableValue.
The field selectedValue can contain only one value from the possibleValues list field. |
void |
setProcessInstanceVariable(ProcessInstanceUUID instanceUUID,
java.lang.String variableId,
java.lang.Object variableValue)
Searches for variable with id variableId within the given process instance with ProcessInstanceUUID instanceUUID. If the variable is found, the given value is set. If the XPDL dataField is String type then use instance of java.lang.String class for variableValue. If the XPDL dataField is Enumeration type then use instance of Enumeration class for variableValue.
The field selectedValue of Enumeration type can contain only one value
from the possibleValues list field. |
void |
setVariable(ActivityInstanceUUID activityUUID,
java.lang.String variableId,
java.lang.Object variableValue)
Searches for variable with id variableId within the given activity instance with the given UUID. If the variable is found within the activity, the given value is set. If the variable is not found within the activity the search is performed within the process instance. If the variable is found within the process instance, the given value is set. |
void |
startTask(TaskUUID taskUUID,
boolean assignTask)
Starts the task. |
void |
suspendTask(TaskUUID taskUUID,
boolean assignTask)
Suspends the task if the task has EXECUTING state. If successful, this operation changes task state from EXECUTING to SUSPENDED. If the boolean assignTask is true the task is also assigned to the logged user otherwise the assignment of the task is not affected by this operation. |
void |
unassignTask(TaskUUID taskUUID)
If this task had a userId set, set it to null. |
Method Detail |
---|
ProcessInstanceUUID instantiateProcess(ProcessDefinitionUUID processUUID) throws ProcessNotFoundException
processUUID
- the process UUID.
ProcessNotFoundException
- if the process has not been found.
BonitaInternalException
- if an exception occurs.ProcessInstanceUUID instantiateProcess(ProcessDefinitionUUID processUUID, java.util.Map<java.lang.String,java.lang.Object> variables) throws ProcessNotFoundException, VariableNotFoundException
processUUID
- the process UUID.variables
- variables added to the variables already set within the process definition
the variable object can be: an Enumeration
,
a plain String
, a Boolean
, a Date
, a Long
or a Double
.
ProcessNotFoundException
- if the process has not been found.
BonitaInternalException
- if an exception occurs.
VariableNotFoundException
void startTask(TaskUUID taskUUID, boolean assignTask) throws TaskNotFoundException, IllegalTaskStateException
taskUUID
- the task UUID.assignTask
- true to assign the task to the logged user; false to don't assign the task.
TaskNotFoundException
- if the task has not been found.
IllegalTaskStateException
- if the state of the task has not READY state.
BonitaInternalException
- if an exception occurs.void finishTask(TaskUUID taskUUID, boolean taskAssign) throws TaskNotFoundException, IllegalTaskStateException
taskUUID
- the task UUID.
TaskNotFoundException
- if the task has not been found.
IllegalTaskStateException
- if the state of the task has not EXECUTING state.
BonitaInternalException
- if an exception occurs.void suspendTask(TaskUUID taskUUID, boolean assignTask) throws TaskNotFoundException, IllegalTaskStateException
taskUUID
- the task UUID.
TaskNotFoundException
- if the task has not been found.
IllegalTaskStateException
- if the state of the task has not either READY or EXECUTING state.
BonitaInternalException
- if an exception occurs.void resumeTask(TaskUUID taskUUID, boolean taskAssign) throws TaskNotFoundException, IllegalTaskStateException
taskUUID
- the task UUID.
TaskNotFoundException
- if the task has not been found.
IllegalTaskStateException
- if the state of the task has not SUSPENDED state.
BonitaInternalException
- if an other exception occurs.void assignTask(TaskUUID taskUUID) throws TaskNotFoundException
taskUUID
- the task UUID.
TaskNotFoundException
- if the task has not been found.
BonitaInternalException
- if an other exception occurs.void assignTask(TaskUUID taskUUID, java.lang.String actorId) throws TaskNotFoundException
taskUUID
- the task UUID.actorId
- the actor id.
TaskNotFoundException
- if the task has not been found.void assignTask(TaskUUID taskUUID, java.util.Set<java.lang.String> candidates) throws TaskNotFoundException
taskUUID
- the task UUID.candidates
- the set of candidate actors.
TaskNotFoundException
- if the task has not been found.void unassignTask(TaskUUID taskUUID) throws TaskNotFoundException
taskUUID
- the task UUID.candidates
- the set of candidate actors.
TaskNotFoundException
- if the task has not been found.void setProcessInstanceVariable(ProcessInstanceUUID instanceUUID, java.lang.String variableId, java.lang.Object variableValue) throws InstanceNotFoundException, VariableNotFoundException
Enumeration
class for variableValue.
instanceUUID
- the instance UUID.variableId
- the variable id.variableValue
- the variable value (can be: an Enumeration
,
a plain String
, a Boolean
, a Date
, a Long
or a Double
).
InstanceNotFoundException
- if the instance has not been found.
VariableNotFoundException
- if the variable has not been found.
BonitaInternalException
- if an exception occurs.void cancelProcessInstance(ProcessInstanceUUID instanceUUID) throws InstanceNotFoundException, UncancellableInstanceException
instanceUUID
- the instance UUID.
InstanceNotFoundException
- if if the instance has not been found.
BonitaInternalException
- if an exception occurs.
UncancellableInstanceException
void setVariable(ActivityInstanceUUID activityUUID, java.lang.String variableId, java.lang.Object variableValue) throws ActivityNotFoundException, VariableNotFoundException
Searches for variable with id variableId within the given activity instance
with the given UUID.
If the variable is found within the activity, the given value is set.
If the variable is not found within the activity the search is performed
within the process instance.
If the variable is found within the process instance, the given value is set.
Enumeration
class for variableValue.
activityUUID
- the activity UUID.variableId
- the variable id.variableValue
- the variable value (can be: an Enumeration
,
a plain String
, a Boolean
, a Date
, a Long
or a Double
).
VariableNotFoundException
- if the variable has not been found.
BonitaInternalException
- if an exception occurs.
ActivityNotFoundException
void setActivityInstanceVariable(ActivityInstanceUUID activityUUID, java.lang.String variableId, java.lang.Object variableValue) throws ActivityNotFoundException, VariableNotFoundException
Enumeration
class for variableValue.
activityUUID
- the activity UUID.variableId
- the variable id.variableValue
- the variable value(can be: an Enumeration
,
a plain String
, a Boolean
, a Date
, a Long
or a Double
).
ActivityNotFoundException
- if the activity has not been found.
VariableNotFoundException
- if the variable has not been found.
BonitaInternalException
- if an exception occurs.void deleteProcessInstance(ProcessInstanceUUID instanceUUID) throws InstanceNotFoundException, UndeletableInstanceException
instanceUUID
- the instance UUID.
InstanceNotFoundException
- if if the instance has not been found.
BonitaInternalException
- if an exception occurs.
UndeletableInstanceException
void deleteAllProcessInstances(ProcessDefinitionUUID processUUID) throws ProcessNotFoundException, UndeletableInstanceException
processUUID
- the process UUID.
ProcessNotFoundException
- if the process with the given UUID does not exists.
BonitaInternalException
- if an exception occurs.
UndeletableInstanceException
void addComment(ProcessInstanceUUID instanceUUID, ActivityInstanceUUID activityUUID, java.lang.String message, java.lang.String userId) throws InstanceNotFoundException, ActivityNotFoundException
instanceUUID
- the process instance UUIDactivityUUID
- the activity UUID, can be nullmessage
- the commentuserId
- the userId
InstanceNotFoundException
- if the instance has not been found.
ActivityNotFoundException
- if the activity has not been found.void addProcessMetaData(ProcessDefinitionUUID uuid, java.lang.String key, java.lang.String value) throws ProcessNotFoundException
uuid
- the process UUID.key
- the key of the meta datavalue
- the value of the meta data
ProcessNotFound
- if the process with the given UUID does not exists.
ProcessNotFoundException
void deleteProcessMetaData(ProcessDefinitionUUID uuid, java.lang.String key) throws ProcessNotFoundException
uuid
- the process UUIDkey
- the key of the meta data
ProcessNotFoundException
- if the process with the given UUID does not exists.java.lang.Object evaluateGroovyExpression(java.lang.String expression, ProcessInstanceUUID instanceUUID) throws InstanceNotFoundException
expression
- the expressioninstanceUUID
- the process instance UUID
InstanceNotFoundException
- if the instance has not been found.java.lang.Object evaluateGroovyExpression(java.lang.String expression, ActivityInstanceUUID activityUUID) throws InstanceNotFoundException, ActivityNotFoundException
expression
- the expressionactivityUUID
- the activityUUID
InstanceNotFoundException
- if the instance has not been found.
ActivityNotFoundException
- if the activity has not been found.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |