|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface QueryRuntimeAPI
Getters on workflow recorded data. Operations in this API applies to main entities managed by Nova Bonita such as: packages, processes, process instances, activities, tasks. Returned records are issued from recorded runtime informations (both runtime and archived workflow instances).
Method Summary | |
---|---|
java.util.Map<java.lang.String,ActivityInst> |
getActivities(java.lang.String instanceId)
Returns all records of activity for the given instance id. |
ActivityInst |
getActivity(java.lang.String instanceId,
java.lang.String activityId)
Returns the record of the activity with the given instance id and activity id. |
ProcessInst |
getInstance(java.lang.String instanceId)
Returns the record of the instance with the given id. |
java.util.Map<java.lang.String,ProcessInst> |
getInstances(java.lang.String processId)
Returns all records of instance for the given process id. |
TaskInst |
getTask(java.lang.String taskId)
Returns the record of the task with the given task id. |
java.util.Collection<TaskInst> |
getTaskList(org.ow2.bonita.util.Constants.TaskState taskState)
Obtain the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given instance. |
java.util.Collection<TaskInst> |
getTaskList(java.lang.String instanceId,
org.ow2.bonita.util.Constants.TaskState taskState)
Obtain the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given instance. |
java.util.Map<java.lang.String,TaskInst> |
getTasks(java.lang.String instanceId)
Returns all records of task for the given instance id. |
java.lang.Object |
getVariable(java.lang.String instanceId,
java.lang.String variableId)
Obtain a process variable for the given instance and variable . |
java.lang.Object |
getVariable(java.lang.String instanceId,
java.lang.String activityId,
java.lang.String variableId)
Obtain a variable for the given activity and instance. |
java.util.Map<java.lang.String,java.lang.Object> |
getVariableDefinitions(java.lang.String processId)
Obtain the variable definitions of the process for the given process. |
java.util.Map<java.lang.String,java.lang.Object> |
getVariableDefinitions(java.lang.String processId,
java.lang.String activityId)
Obtain variable definitions (including global process and local activity variables)for the given process and activity. |
java.util.Map<java.lang.String,java.lang.Object> |
getVariables(java.lang.String instanceId)
Obtain the process variables for the given instance. |
java.util.Map<java.lang.String,java.lang.Object> |
getVariables(java.lang.String instanceId,
java.lang.String activityId)
Obtain the activity variables (including global process and local activity variables) for the given instance and activity. |
Method Detail |
---|
ProcessInst getInstance(java.lang.String instanceId) throws org.ow2.bonita.facade.exception.InstanceNotFoundException
instanceId
- the instance id.
org.ow2.bonita.facade.exception.InstanceNotFoundException
- if no instance has been found with the given instance id.
BonitaInternalException
- if an exception occurs.java.util.Map<java.lang.String,ProcessInst> getInstances(java.lang.String processId) throws org.ow2.bonita.facade.exception.ProcessNotFoundException
processId
- the process id.
org.ow2.bonita.facade.exception.ProcessNotFoundException
- if no process has been found with the given process id.
BonitaInternalException
- if an exception occurs.ActivityInst getActivity(java.lang.String instanceId, java.lang.String activityId) throws org.ow2.bonita.facade.exception.InstanceNotFoundException, org.ow2.bonita.facade.exception.ActivityNotFoundException
instanceId
- the instance id.activityId
- the activity id.
org.ow2.bonita.facade.exception.InstanceNotFoundException
- if no instance has been found with the given instance id.
org.ow2.bonita.facade.exception.ActivityNotFoundException
- if no activity has been found with the given activity id.
BonitaInternalException
- if an exception occurs.java.util.Map<java.lang.String,ActivityInst> getActivities(java.lang.String instanceId) throws org.ow2.bonita.facade.exception.InstanceNotFoundException
instanceId
- the instance id.
org.ow2.bonita.facade.exception.InstanceNotFoundException
- if no instance has been found with the given instance id.
BonitaInternalException
- if an exception occurs.TaskInst getTask(java.lang.String taskId) throws org.ow2.bonita.facade.exception.TaskNotFoundException
taskId
- the task id.
org.ow2.bonita.facade.exception.TaskNotFoundException
- if no task has been found with the given task id.
BonitaInternalException
- if an exception occurs.java.util.Map<java.lang.String,TaskInst> getTasks(java.lang.String instanceId) throws org.ow2.bonita.facade.exception.InstanceNotFoundException
instanceId
- the instance id.
org.ow2.bonita.facade.exception.InstanceNotFoundException
- if no instance has been found with the given instance id.
BonitaInternalException
- if an exception occurs.java.util.Collection<TaskInst> getTaskList(java.lang.String instanceId, org.ow2.bonita.util.Constants.TaskState taskState) throws org.ow2.bonita.facade.exception.InstanceNotFoundException
Obtain the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given instance.
instanceId
- the instance id.taskState
- the state of the task.
org.ow2.bonita.facade.exception.InstanceNotFoundException
- if no instance record is found with the given instance id.
BonitaInternalException
- if an other exception occurs.java.util.Collection<TaskInst> getTaskList(org.ow2.bonita.util.Constants.TaskState taskState)
Obtain the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given instance.
taskState
- the state of the task.
BonitaInternalException
- if an other exception occurs.java.lang.Object getVariable(java.lang.String instanceId, java.lang.String activityId, java.lang.String variableId) throws org.ow2.bonita.facade.exception.InstanceNotFoundException, org.ow2.bonita.facade.exception.ActivityNotFoundException, org.ow2.bonita.facade.exception.VariableNotFoundException
instanceId
- the instance id.activityId
- the activity id.variableId
- the variable id.
org.ow2.bonita.facade.exception.InstanceNotFoundException
- if no instance has been found with the given instance id.
org.ow2.bonita.facade.exception.ActivityNotFoundException
- if this activity is not pointed by a process execution
and the execution informations for this activity has not been recorded.
org.ow2.bonita.facade.exception.VariableNotFoundException
- if no variable is found with the given id.
BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,java.lang.Object> getVariables(java.lang.String instanceId, java.lang.String activityId) throws org.ow2.bonita.facade.exception.ActivityNotFoundException, org.ow2.bonita.facade.exception.InstanceNotFoundException
instanceId
- the instance id.activityId
- the activity id.
org.ow2.bonita.facade.exception.ActivityNotFoundException
- if this activity is not pointed by a process execution
and the execution informations for this activity has not been recorded.
BonitaInternalException
- if an other exception occurs.
org.ow2.bonita.facade.exception.InstanceNotFoundException
java.lang.Object getVariable(java.lang.String instanceId, java.lang.String variableId) throws org.ow2.bonita.facade.exception.InstanceNotFoundException, org.ow2.bonita.facade.exception.VariableNotFoundException
instanceId
- the instance id.variableId
- the variable id.
org.ow2.bonita.facade.exception.InstanceNotFoundException
- if no instance has found with the given instance id.
org.ow2.bonita.facade.exception.VariableNotFoundException
- if no variable is found with the given id.
BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,java.lang.Object> getVariables(java.lang.String instanceId) throws org.ow2.bonita.facade.exception.InstanceNotFoundException
instanceId
- the instance id.
org.ow2.bonita.facade.exception.InstanceNotFoundException
- if no instance has been found with the given instance id.
BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,java.lang.Object> getVariableDefinitions(java.lang.String processId, java.lang.String activityId) throws org.ow2.bonita.facade.exception.ProcessNotFoundException, org.ow2.bonita.facade.exception.ActivityNotFoundException
processId
- the process Id.activityId
- the activity id.
org.ow2.bonita.facade.exception.ProcessNotFoundException
- if no process record is found with the given process id.
org.ow2.bonita.facade.exception.ActivityNotFoundException
- if this activity is not pointed by a process execution
and the execution informations for this activity has not been recorded.
BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,java.lang.Object> getVariableDefinitions(java.lang.String processId) throws org.ow2.bonita.facade.exception.ProcessNotFoundException
processId
- the process Id.
org.ow2.bonita.facade.exception.ProcessNotFoundException
- if no process has been found with the given process id.
BonitaInternalException
- if an other exception occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |