|
|||||||||
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 |
addActivityInstanceVariable(ActivityInstanceUUID activityUUID,
java.lang.String variableId,
java.lang.Object variableValue)
|
void |
addActivityInstanceVariable(ProcessInstanceUUID instanceUUID,
java.lang.String activityId,
java.lang.String variableId,
java.lang.Object variableValue)
|
void |
addProcessInstanceVariable(ProcessInstanceUUID instanceUUID,
java.lang.String variableId,
java.lang.Object variableValue)
|
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)
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)
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 |
setActivityInstanceVariable(ProcessInstanceUUID instanceUUID,
java.lang.String activityId,
java.lang.String variableId,
java.lang.Object variableValue)
Searches for variable with id variableId into instance with UUID processUUID and within the activity with id activityId. |
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(ProcessInstanceUUID instanceUUID,
java.lang.String activityId,
java.lang.String variableId,
java.lang.Object variableValue)
|
void |
startTask(TaskUUID taskUUID)
starts the task. |
void |
suspendTask(TaskUUID taskUUID)
Suspends the task if the task has EXECUTING state. |
Method Detail |
---|
ProcessInstanceUUID instantiateProcess(ProcessDefinitionUUID processUUID) throws ProcessNotFoundException
instantiateProcess
in interface org.ow2.bonita.facade.remote.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 org.ow2.bonita.facade.remote.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) throws TaskNotFoundException, IllegalTaskStateException
startTask
in interface org.ow2.bonita.facade.remote.RemoteRuntimeAPI
taskUUID
- the task UUID.
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) throws TaskNotFoundException, IllegalTaskStateException
finishTask
in interface org.ow2.bonita.facade.remote.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) throws TaskNotFoundException, IllegalTaskStateException, UnAuthorizedUserException
suspendTask
in interface org.ow2.bonita.facade.remote.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.
UnAuthorizedUserException
- if the user is not the user assigned to the task.
UnAuthorizedUserException
- if task has not been assigned and the user is not in the list of candidates for the task.
BonitaInternalException
- if an exception occurs.void resumeTask(TaskUUID taskUUID) throws TaskNotFoundException, IllegalTaskStateException, UnAuthorizedUserException
resumeTask
in interface org.ow2.bonita.facade.remote.RemoteRuntimeAPI
taskUUID
- the task UUID.
TaskNotFoundException
- if the task has not been found.
IllegalTaskStateException
- if the state of the task has not SUSPENDED state.
UnAuthorizedUserException
- if the user is not the user assigned to the task.
UnAuthorizedUserException
- if task has not been assigned and the user is not in the list of candidates for the task.
BonitaInternalException
- if an exception occurs.void setProcessInstanceVariable(ProcessInstanceUUID instanceUUID, java.lang.String variableId, java.lang.Object variableValue) throws InstanceNotFoundException, VariableNotFoundException
setProcessInstanceVariable
in interface org.ow2.bonita.facade.remote.RemoteRuntimeAPI
instanceUUID
- the instance UUID.variableId
- the variable id.variableValue
- the variable value.
InstanceNotFoundException
- if the instance has not been found.
BonitaInternalException
- if an exception occurs.
VariableNotFoundException
void setVariable(ProcessInstanceUUID instanceUUID, java.lang.String activityId, java.lang.String variableId, java.lang.Object variableValue) throws InstanceNotFoundException, ActivityNotFoundException, VariableNotFoundException
setVariable
in interface org.ow2.bonita.facade.remote.RemoteRuntimeAPI
InstanceNotFoundException
ActivityNotFoundException
VariableNotFoundException
void setActivityInstanceVariable(ProcessInstanceUUID instanceUUID, java.lang.String activityId, java.lang.String variableId, java.lang.Object variableValue) throws InstanceNotFoundException, ActivityNotFoundException, VariableNotFoundException
setActivityInstanceVariable
in interface org.ow2.bonita.facade.remote.RemoteRuntimeAPI
instanceUUID
- the instance UUID.activityId
- the activity id.variableId
- the variable id.variableValue
- the variable value.
InstanceNotFoundException
- if the instance has not been found.
ActivityNotFoundException
- if the activity has not been found.
BonitaInternalException
- if an exception occurs.
VariableNotFoundException
void setActivityInstanceVariable(ActivityInstanceUUID activityUUID, java.lang.String variableId, java.lang.Object variableValue) throws ActivityNotFoundException, VariableNotFoundException
setActivityInstanceVariable
in interface org.ow2.bonita.facade.remote.RemoteRuntimeAPI
activityUUID
- the activity UUID.variableId
- the variable id.variableValue
- the variable value.
ActivityNotFoundException
- if the activity has not been found.
BonitaInternalException
- if an exception occurs.
VariableNotFoundException
void addProcessInstanceVariable(ProcessInstanceUUID instanceUUID, java.lang.String variableId, java.lang.Object variableValue) throws InstanceNotFoundException, VariableAlreadyExistException
addProcessInstanceVariable
in interface org.ow2.bonita.facade.remote.RemoteRuntimeAPI
InstanceNotFoundException
VariableAlreadyExistException
void addActivityInstanceVariable(ProcessInstanceUUID instanceUUID, java.lang.String activityId, java.lang.String variableId, java.lang.Object variableValue) throws InstanceNotFoundException, ActivityNotFoundException, VariableAlreadyExistException
addActivityInstanceVariable
in interface org.ow2.bonita.facade.remote.RemoteRuntimeAPI
InstanceNotFoundException
ActivityNotFoundException
VariableAlreadyExistException
void addActivityInstanceVariable(ActivityInstanceUUID activityUUID, java.lang.String variableId, java.lang.Object variableValue) throws ActivityNotFoundException, VariableAlreadyExistException
addActivityInstanceVariable
in interface org.ow2.bonita.facade.remote.RemoteRuntimeAPI
ActivityNotFoundException
VariableAlreadyExistException
void deleteProcessInstance(ProcessInstanceUUID instanceUUID) throws InstanceNotFoundException
deleteProcessInstance
in interface org.ow2.bonita.facade.remote.RemoteRuntimeAPI
instanceUUID
- the instance UUID.
InstanceNotFoundException
- if if the instance has not been found.
BonitaInternalException
- if an exception occurs.void deleteAllProcessInstances(ProcessDefinitionUUID processUUID)
deleteAllProcessInstances
in interface org.ow2.bonita.facade.remote.RemoteRuntimeAPI
processUUID
- the process UUID.
BonitaInternalException
- if an exception occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |