|
|||||||||
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:
Method Summary | |
---|---|
void |
deleteAllInstances(java.lang.String processId)
This method is only dedicated for bonita unit tests! |
void |
deleteInstance(java.lang.String instanceId)
This method is only dedicated for bonita unit tests! |
void |
finishTask(java.lang.String taskId)
Finish the task. |
java.lang.String |
instantiateProcess(java.lang.String processId)
Create an instance of the specified process and start the execution. |
java.lang.String |
instantiateProcess(java.lang.String processId,
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(java.lang.String taskId)
Resume the task if the task has SUSPENDED state. |
void |
setVariable(java.lang.String instanceId,
java.lang.String variableId,
java.lang.Object variableValue)
Search for variable with id variableId into instance with id instanceId and set the given value to the found variable. |
void |
setVariable(java.lang.String instanceId,
java.lang.String activityId,
java.lang.String variableId,
java.lang.Object variableValue)
Search for variable with id variableId into instance with id instanceId and within the activity with id activityId and set the given value to the found variable. |
void |
startTask(java.lang.String taskId)
start the task. |
void |
suspendTask(java.lang.String taskId)
Suspend the task if the task has EXECUTING state. |
Methods inherited from interface org.ow2.bonita.facade.RuntimeReadOnlyAPI |
---|
getTaskList, getTaskList, getVariable, getVariable, getVariableDefinitions, getVariableDefinitions, getVariables, getVariables |
Method Detail |
---|
java.lang.String instantiateProcess(java.lang.String processId) throws ProcessNotFoundException
processId
- the process id.
ProcessNotFoundException
- if the process has not been found.
BonitaInternalException
- if an exception occurs.java.lang.String instantiateProcess(java.lang.String processId, java.util.Map<java.lang.String,java.lang.Object> variables) throws ProcessNotFoundException
processId
- the process id.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(java.lang.String taskId) throws TaskNotFoundException, IllegalTaskStateException
taskId
- the task id.
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(java.lang.String taskId) throws TaskNotFoundException, IllegalTaskStateException
taskId
- the task id.
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(java.lang.String taskId) throws TaskNotFoundException, IllegalTaskStateException, UnAuthorizedUserException
taskId
- the task id.
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.
UnAuthorizedUserException
void resumeTask(java.lang.String taskId) throws TaskNotFoundException, IllegalTaskStateException, UnAuthorizedUserException
taskId
- the task id.
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 setVariable(java.lang.String instanceId, java.lang.String variableId, java.lang.Object variableValue) throws InstanceNotFoundException
instanceId
- the instance id.variableId
- the variable id.variableValue
- the variable value.
InstanceNotFoundException
- if the instance has not been found.
BonitaInternalException
- if an exception occurs.void setVariable(java.lang.String instanceId, java.lang.String activityId, java.lang.String variableId, java.lang.Object variableValue) throws InstanceNotFoundException, ActivityNotFoundException
instanceId
- the instance id.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 deleteInstance(java.lang.String instanceId)
instanceId
- the instance id.
BonitaInternalException
- if an exception occurs.void deleteAllInstances(java.lang.String processId)
processId
- the process id.
BonitaInternalException
- if an exception occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |