|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RuntimeAPI
Main API responsible of workflow state change operations. Those operations concerns tasks, process instances and variables. Default states for tasks (aka manual activities), processes instances, activities and processes are:
TxHook
Method Summary | |
---|---|
void |
clearHistory()
|
void |
deleteAllInstances(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processUUID)
This method is only dedicated for bonita unit tests! |
void |
deleteInstance(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID)
This method is only dedicated for bonita unit tests! |
void |
finishTask(org.ow2.bonita.facade.uuid.TaskUUID taskUUID)
Finish the task. |
org.ow2.bonita.facade.uuid.ProcessInstanceUUID |
instantiateProcess(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processUUID)
Create an instance of the specified process and start the execution. |
org.ow2.bonita.facade.uuid.ProcessInstanceUUID |
instantiateProcess(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processUUID,
java.util.Map<java.lang.String,java.lang.Object> variables)
create an instance of the specified process with the added variable map and start the execution. |
void |
resumeTask(org.ow2.bonita.facade.uuid.TaskUUID taskUUID)
Resume the task if the task has SUSPENDED state. |
void |
setActivityVariable(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID,
java.lang.String variableId,
java.lang.Object variableValue)
|
void |
setActivityVariable(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID,
java.lang.String activityId,
java.lang.String variableId,
java.lang.Object variableValue)
Search for variable with id variableId into instance with UUID instanceUUID and within the activity with id activityId and set the given value to the found variable. |
void |
setInstanceVariable(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID,
java.lang.String variableId,
java.lang.Object variableValue)
Search for variable with id variableId into instance with UUID instanceUUID and set the given value to the found variable. |
void |
startTask(org.ow2.bonita.facade.uuid.TaskUUID taskUUID)
start the task. |
void |
suspendTask(org.ow2.bonita.facade.uuid.TaskUUID taskUUID)
Suspend the task if the task has EXECUTING state. |
Method Detail |
---|
org.ow2.bonita.facade.uuid.ProcessInstanceUUID instantiateProcess(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processUUID) throws ProcessNotFoundException
processUUID
- the process UUID.
ProcessNotFoundException
- if the process has not been found.
BonitaInternalException
- if an exception occurs.org.ow2.bonita.facade.uuid.ProcessInstanceUUID instantiateProcess(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processUUID, java.util.Map<java.lang.String,java.lang.Object> variables) throws ProcessNotFoundException
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(org.ow2.bonita.facade.uuid.TaskUUID taskUUID) throws TaskNotFoundException, IllegalTaskStateException
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(org.ow2.bonita.facade.uuid.TaskUUID taskUUID) 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(org.ow2.bonita.facade.uuid.TaskUUID taskUUID) throws TaskNotFoundException, IllegalTaskStateException, UnAuthorizedUserException
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(org.ow2.bonita.facade.uuid.TaskUUID taskUUID) throws TaskNotFoundException, IllegalTaskStateException, UnAuthorizedUserException
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 setInstanceVariable(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID, java.lang.String variableId, java.lang.Object variableValue) throws InstanceNotFoundException
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.void setActivityVariable(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID, java.lang.String activityId, java.lang.String variableId, java.lang.Object variableValue) throws InstanceNotFoundException, ActivityNotFoundException
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.void setActivityVariable(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID, java.lang.String variableId, java.lang.Object variableValue) throws ActivityNotFoundException
ActivityNotFoundException
void deleteInstance(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID) throws InstanceNotFoundException
instanceUUID
- the instance UUID.
BonitaInternalException
- if an exception occurs.
InstanceNotFoundException
void deleteAllInstances(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processUUID)
processUUID
- the process UUID.
BonitaInternalException
- if an exception occurs.void clearHistory()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |