|
|||||||||
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).
RoleMapper
,
PerformerAssign
,
Hook
Method Summary | |
---|---|
ActivityInstance<ActivityBody> |
getActivityInstance(ActivityInstanceUUID activityUUID)
Returns the record of the activity with the given activity UUID. |
ActivityInstance<ActivityBody> |
getActivityInstance(ProcessInstanceUUID instanceUUID,
java.lang.String activityId)
Returns the record of the activity with the given instance UUID and activity Id. |
ActivityInstance<ActivityBody> |
getActivityInstance(ProcessInstanceUUID instanceUUID,
java.lang.String activityId,
java.lang.String iterationId)
Returns the record of the activity with the given instance processDefinitionUUID and activity processDefinitionUUID. |
java.util.Set<ActivityInstance<ActivityBody>> |
getActivityInstances(ProcessInstanceUUID instanceUUID)
Returns all records of activity for the given instance UUID. |
java.util.Set<ActivityInstance<ActivityBody>> |
getActivityInstances(ProcessInstanceUUID instanceUUID,
java.lang.String activityId)
Returns records for all iterations that should happend for the given instance UUID and activity Id. |
java.lang.Object |
getActivityInstanceVariable(ActivityInstanceUUID activityUUID,
java.lang.String variableId)
Obtain a variable for the given activity UUID. |
java.lang.Object |
getActivityInstanceVariable(ProcessInstanceUUID instanceUUID,
java.lang.String activityId,
java.lang.String variableId)
Obtain a variable for the given activity and instance. |
java.lang.Object |
getActivityInstanceVariable(ProcessInstanceUUID instanceUUID,
java.lang.String activityId,
java.lang.String iterationId,
java.lang.String variableId)
Obtain a variable for the given the given instance UUID, the activity Id and the iterationId, variableId. |
java.util.Map<java.lang.String,java.lang.Object> |
getActivityInstanceVariables(ActivityInstanceUUID activityUUID)
Obtain the activity variables (including global process and local activity variables) for the given activity UUID. |
java.util.Map<java.lang.String,java.lang.Object> |
getActivityInstanceVariables(ProcessInstanceUUID instanceUUID,
java.lang.String activityId)
Obtain the activity variables (including global process and local activity variables) for the given instance UUID and activity Id. |
java.util.Map<java.lang.String,java.lang.Object> |
getActivityInstanceVariables(ProcessInstanceUUID instanceUUID,
java.lang.String activityId,
java.lang.String iterationId)
Obtain the activity variables (including global process and local activity variables) for the given instance UUID, the activity Id and the iterationId An empty map is returned if no variable is found. |
java.util.Map<java.lang.String,java.lang.Object> |
getActivityVariableDefinitions(ProcessDefinitionUUID processUUID,
java.lang.String activityId)
Obtain variable definitions (including global process and local activity variables)for the given process and activity. |
ProcessInstance |
getProcessInstance(ProcessInstanceUUID instanceUUID)
Returns the record of the instance with the given UUID. |
java.util.Set<ProcessInstance> |
getProcessInstances(ProcessDefinitionUUID processUUID)
Returns all records of instance for the given process processDefinitionUUID. |
java.lang.Object |
getProcessInstanceVariable(ProcessInstanceUUID instanceUUID,
java.lang.String variableId)
Obtain a process variable for the given instance and variable. |
java.util.Map<java.lang.String,java.lang.Object> |
getProcessInstanceVariables(ProcessInstanceUUID instanceUUID)
Obtain the process variables for the given instance. |
java.util.Map<java.lang.String,java.lang.Object> |
getProcessVariableDefinitions(ProcessDefinitionUUID processUUID)
Obtain the variable definitions of the process for the given process. |
ActivityInstance<TaskInstance> |
getTask(TaskUUID taskUUID)
Returns the record of the task with the given task UUID. |
java.util.Collection<ActivityInstance<TaskInstance>> |
getTaskList(ProcessInstanceUUID instanceUUID,
java.lang.String userId,
TaskState taskState)
Obtain the tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given instance for the given user id. |
java.util.Collection<ActivityInstance<TaskInstance>> |
getTaskList(ProcessInstanceUUID instanceUUID,
TaskState taskState)
Obtain the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given instance. |
java.util.Collection<ActivityInstance<TaskInstance>> |
getTaskList(java.lang.String userId,
TaskState taskState)
Obtain the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given instance for the given user id. |
java.util.Collection<ActivityInstance<TaskInstance>> |
getTaskList(TaskState taskState)
Obtain the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given instance. |
java.util.Set<ActivityInstance<TaskInstance>> |
getTasks(ProcessInstanceUUID instanceUUID)
Returns all records of task for the given instance UUID. |
java.lang.Object |
getVariable(ProcessInstanceUUID instanceUUID,
java.lang.String activityId,
java.lang.String variableId)
|
java.util.Map<java.lang.String,java.lang.Object> |
getVariables(ProcessInstanceUUID instanceUUID,
java.lang.String activityId,
java.lang.String variableId)
|
Method Detail |
---|
ProcessInstance getProcessInstance(ProcessInstanceUUID instanceUUID) throws InstanceNotFoundException
getProcessInstance
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
instanceUUID
- the instance UUID.
InstanceNotFoundException
- if no instance has been found with the given instance UUID.
BonitaInternalException
- if an exception occurs.java.util.Set<ProcessInstance> getProcessInstances(ProcessDefinitionUUID processUUID) throws ProcessNotFoundException
getProcessInstances
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
processUUID
- the process definition UUID.
ProcessNotFoundException
- if no process has been found with the given process UUID.
BonitaInternalException
- if an exception occurs.ActivityInstance<ActivityBody> getActivityInstance(ProcessInstanceUUID instanceUUID, java.lang.String activityId, java.lang.String iterationId) throws InstanceNotFoundException, ActivityNotFoundException
getActivityInstance
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
instanceUUID
- the instance processDefinitionUUID.activityId
- the activity Id as specified in the xpdl file.iterationId
- the iteration Id.
InstanceNotFoundException
- if no instance has been found with the given instance UUID.
ActivityNotFoundException
- if no activity has been found with the given activity id.
BonitaInternalException
- if an exception occurs.ActivityInstance<ActivityBody> getActivityInstance(ActivityInstanceUUID activityUUID) throws ActivityNotFoundException
getActivityInstance
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
activityUUID
- the activity UUID.
InstanceNotFoundException
- if no instance has been found with the given instance UUID.
ActivityNotFoundException
- if no activity has been found with the given activity id.
BonitaInternalException
- if an exception occurs.ActivityInstance<ActivityBody> getActivityInstance(ProcessInstanceUUID instanceUUID, java.lang.String activityId) throws InstanceNotFoundException, ActivityNotFoundException, ActivityInIterationException
getActivityInstance
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
instanceUUID
- the instance processDefinitionUUID.activityId
- the activity Id as specified in the xpdl file.
InstanceNotFoundException
- if no instance has been found with the given instance UUID.
ActivityNotFoundException
- if no activity has been found with the given activity id.
ActivityInIterationException
- if there's iterations.
BonitaInternalException
- if an exception occurs.java.util.Set<ActivityInstance<ActivityBody>> getActivityInstances(ProcessInstanceUUID instanceUUID) throws InstanceNotFoundException
getActivityInstances
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
instanceUUID
- the instance UUID.
InstanceNotFoundException
- if no instance has been found with the given instance UUID.
BonitaInternalException
- if an exception occurs.java.util.Set<ActivityInstance<ActivityBody>> getActivityInstances(ProcessInstanceUUID instanceUUID, java.lang.String activityId) throws InstanceNotFoundException, ActivityNotFoundException
getActivityInstances
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
instanceUUID
- the instance UUID.activityId
- the activity Id (as specified into the XPDL file).
InstanceNotFoundException
- if no instance has been found with the given instance UUID.
BonitaInternalException
- if an exception occurs.
ActivityNotFoundException
ActivityInstance<TaskInstance> getTask(TaskUUID taskUUID) throws TaskNotFoundException
getTask
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
taskUUID
- the task UUID.
TaskNotFoundException
- if no task has been found with the given task UUID.
BonitaInternalException
- if an exception occurs.java.util.Set<ActivityInstance<TaskInstance>> getTasks(ProcessInstanceUUID instanceUUID) throws InstanceNotFoundException
getTasks
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
instanceUUID
- the instance UUID.
InstanceNotFoundException
- if no instance has been found with the given instance UUID.
BonitaInternalException
- if an exception occurs.java.util.Collection<ActivityInstance<TaskInstance>> getTaskList(ProcessInstanceUUID instanceUUID, TaskState taskState) throws InstanceNotFoundException
Obtain the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given instance.
getTaskList
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
instanceUUID
- the instance UUID.taskState
- the state
of the task.
InstanceNotFoundException
- if no instance record is found with the given instance UUID.
BonitaInternalException
- if an other exception occurs.java.util.Collection<ActivityInstance<TaskInstance>> getTaskList(ProcessInstanceUUID instanceUUID, java.lang.String userId, TaskState taskState) throws InstanceNotFoundException
Obtain the tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given instance for the given user id.
instanceUUID
- the instance UUID.userId
- the userId for which the tasks are searched.taskState
- the state of the task.
InstanceNotFoundException
- if no instance record is found with the given instance UUID.
BonitaInternalException
- if an other exception occurs.java.util.Collection<ActivityInstance<TaskInstance>> getTaskList(TaskState taskState)
Obtain the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given instance.
getTaskList
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
taskState
- the state of the task.
BonitaInternalException
- if an other exception occurs.java.util.Collection<ActivityInstance<TaskInstance>> getTaskList(java.lang.String userId, TaskState taskState)
Obtain the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given instance for the given user id.
userId
- the userId for which the tasks are searched.taskState
- the state of the task.
BonitaInternalException
- if an other exception occurs.java.lang.Object getActivityInstanceVariable(ProcessInstanceUUID instanceUUID, java.lang.String activityId, java.lang.String variableId) throws InstanceNotFoundException, ActivityNotFoundException, ActivityInIterationException, VariableNotFoundException
getActivityInstanceVariable
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
instanceUUID
- the instance UUID.activityId
- the value of the Id attribute of the Activity element defined into the XPDL file.variableId
- the value of the Id attribute of the DataField element defined into the XPDL file.
InstanceNotFoundException
- if no instance has been found with the given instance UUID.
ActivityNotFoundException
- if this activity is not pointed by a process execution
and the execution informations for this activity has not been recorded.
ActivityInIterationException
- if multiple iterations has been occurred for the given activity Id.
VariableNotFoundException
- if no variable is found with the given id.
BonitaInternalException
- if an other exception occurs.java.lang.Object getActivityInstanceVariable(ActivityInstanceUUID activityUUID, java.lang.String variableId) throws ActivityNotFoundException, VariableNotFoundException
getActivityInstanceVariable
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
activityUUID
- the activity UUID.variableId
- the value of the Id attribute of the DataField element defined into the XPDL file.
ActivityNotFoundException
- if this activity is not pointed by a process execution
and the execution informations for this activity has not been recorded.
VariableNotFoundException
- if no variable is found with the given id.
BonitaInternalException
- if an other exception occurs.java.lang.Object getActivityInstanceVariable(ProcessInstanceUUID instanceUUID, java.lang.String activityId, java.lang.String iterationId, java.lang.String variableId) throws InstanceNotFoundException, ActivityNotFoundException, VariableNotFoundException
getActivityInstanceVariable
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
instanceUUID
- the instance UUID.activityId
- the value of the Id attribute of the Activity element defined into the XPDL file.iterationId
- the iteration Id.variableId
- the value of the Id attribute of the DataField element defined into the XPDL file.
ActivityNotFoundException
- if this activity is not pointed by a process execution
and the execution informations for this activity has not been recorded or if the iteration id has not
been found.
InstanceNotFoundException
- if no recorded informations is found with the given instance UUID.
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> getActivityInstanceVariables(ProcessInstanceUUID instanceUUID, java.lang.String activityId) throws ActivityNotFoundException, ActivityInIterationException, InstanceNotFoundException
getActivityInstanceVariables
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
instanceUUID
- the instance UUID.activityId
- the value of the Id attribute of the Activity element defined into the XPDL file.
ActivityNotFoundException
- if this activity is not pointed by a process execution
and the execution informations for this activity has not been recorded.
InstanceNotFoundException
- if no recorded informations is found with the given instance UUID.
ActivityInIterationException
- if multiple iterations has been occurred.
BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,java.lang.Object> getActivityInstanceVariables(ActivityInstanceUUID activityUUID) throws ActivityNotFoundException
getActivityInstanceVariables
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
activityUUID
- the activity UUID.
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> getActivityInstanceVariables(ProcessInstanceUUID instanceUUID, java.lang.String activityId, java.lang.String iterationId) throws ActivityNotFoundException, InstanceNotFoundException
getActivityInstanceVariables
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
instanceUUID
- the instance UUID.activityId
- the value of the Id attribute of the Activity element defined into the XPDL file.iterationId
- the iteration Id.
ActivityNotFoundException
- if this activity is not pointed by a process execution
and the execution informations for this activity has not been recorded or if the iteration id has not
been found.
InstanceNotFoundException
- if no recorded informations is found with the given instance UUID.
BonitaInternalException
- if an other exception occurs.java.lang.Object getVariable(ProcessInstanceUUID instanceUUID, java.lang.String activityId, java.lang.String variableId) throws InstanceNotFoundException, ActivityNotFoundException, VariableNotFoundException
getVariable
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
InstanceNotFoundException
ActivityNotFoundException
VariableNotFoundException
java.util.Map<java.lang.String,java.lang.Object> getVariables(ProcessInstanceUUID instanceUUID, java.lang.String activityId, java.lang.String variableId) throws InstanceNotFoundException, ActivityNotFoundException, VariableNotFoundException
getVariables
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
InstanceNotFoundException
ActivityNotFoundException
VariableNotFoundException
java.lang.Object getProcessInstanceVariable(ProcessInstanceUUID instanceUUID, java.lang.String variableId) throws InstanceNotFoundException, VariableNotFoundException
getProcessInstanceVariable
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
instanceUUID
- the instance UUID.variableId
- the variable id.
InstanceNotFoundException
- if no instance has found with the given instance UUID.
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> getProcessInstanceVariables(ProcessInstanceUUID instanceUUID) throws InstanceNotFoundException
getProcessInstanceVariables
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
instanceUUID
- the instance UUID.
InstanceNotFoundException
- if no instance has been found with the given instance UUID.
BonitaInternalException
- if an other exception occurs.java.util.Map<java.lang.String,java.lang.Object> getActivityVariableDefinitions(ProcessDefinitionUUID processUUID, java.lang.String activityId) throws ProcessNotFoundException, ActivityNotFoundException
getActivityVariableDefinitions
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
processUUID
- the process UUID.activityId
- the activity id as specified in the xpdl file.
ProcessNotFoundException
- if no process record is found with the given process UUID.
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> getProcessVariableDefinitions(ProcessDefinitionUUID processUUID) throws ProcessNotFoundException
getProcessVariableDefinitions
in interface org.ow2.bonita.facade.remote.RemoteQueryRuntimeAPI
processUUID
- the process Id.
ProcessNotFoundException
- if no process has been found with the given process UUID.
BonitaInternalException
- if an other exception occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |