|
||||||||||
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 |
assignTask(TaskUUID taskUUID)
Launches the execution of both roleMapper and performerAssignment for the given task. |
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 |
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 |
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. |
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. |
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. |
void |
startTask(TaskUUID taskUUID,
boolean assignTask)
Starts the task. |
void |
suspendTask(TaskUUID taskUUID,
boolean assignTask)
Suspends the task if the task has EXECUTING state. |
Method Detail |
---|
ProcessInstanceUUID instantiateProcess(ProcessDefinitionUUID processUUID) throws ProcessNotFoundException
instantiateProcess
in interface RemoteRuntimeAPI
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
instantiateProcess
in interface RemoteRuntimeAPI
processUUID
- the process UUID.variables
- variables added to the variables already set within the process definition.
ProcessNotFoundException
- if the process has not been found.
BonitaInternalException
- if an exception occurs.void startTask(TaskUUID taskUUID, boolean assignTask) throws TaskNotFoundException, IllegalTaskStateException
startTask
in interface RemoteRuntimeAPI
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
finishTask
in interface RemoteRuntimeAPI
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
suspendTask
in interface RemoteRuntimeAPI
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
resumeTask
in interface RemoteRuntimeAPI
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
assignTask
in interface RemoteRuntimeAPI
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
assignTask
in interface RemoteRuntimeAPI
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
assignTask
in interface RemoteRuntimeAPI
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.
setProcessInstanceVariable
in interface RemoteRuntimeAPI
instanceUUID
- the instance UUID.variableId
- the variable id.variableValue
- the variable value.
InstanceNotFoundException
- if the instance has not been found.
VariableNotFoundException
- if the variable has not been found.
BonitaInternalException
- if an exception occurs.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.
setVariable
in interface RemoteRuntimeAPI
activityUUID
- the activity UUID.variableId
- the variable id.variableValue
- the variable value.
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.
setActivityInstanceVariable
in interface RemoteRuntimeAPI
activityUUID
- the activity UUID.variableId
- the variable id.variableValue
- the variable value.
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
deleteProcessInstance
in interface RemoteRuntimeAPI
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
deleteAllProcessInstances
in interface RemoteRuntimeAPI
processUUID
- the process UUID.
ProcessNotFoundException
- if the process with the given UUID does not exists.
BonitaInternalException
- if an exception occurs.
UndeletableInstanceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |