|
||||||||||
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. |
java.util.Set<ActivityInstance<ActivityBody>> |
getActivityInstances(ProcessInstanceUUID instanceUUID)
Returns all records of activity for the given process instance UUID. |
java.util.Set<ActivityInstance<ActivityBody>> |
getActivityInstances(ProcessInstanceUUID instanceUUID,
java.lang.String activityId)
Returns records for all iterations and multi-instantiations that should happend for the given process instance UUID and activity Id. |
java.lang.Object |
getActivityInstanceVariable(ActivityInstanceUUID activityUUID,
java.lang.String variableId)
Obtains a variable defined as local to the activity for the given activity UUID and variable Id. |
java.util.Map<java.lang.String,java.lang.Object> |
getActivityInstanceVariables(ActivityInstanceUUID activityUUID)
Obtains the variables defined as local to the activity for the given activity UUID. |
ProcessInstance |
getProcessInstance(ProcessInstanceUUID instanceUUID)
Returns the record of the instance with the given UUID. |
java.util.Set<ProcessInstance> |
getProcessInstances()
Returns all records of instance. |
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)
Obtains a process variable for the given process instance UUID and variable Id. |
java.util.Map<java.lang.String,java.lang.Object> |
getProcessInstanceVariables(ProcessInstanceUUID instanceUUID)
Obtains the process variables for the given process instance UUID. |
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)
Obtains the tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given instance and for the given user. |
java.util.Collection<ActivityInstance<TaskInstance>> |
getTaskList(ProcessInstanceUUID instanceUUID,
TaskState taskState)
Obtains the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given instance and the authenticated user. |
java.util.Collection<ActivityInstance<TaskInstance>> |
getTaskList(java.lang.String userId,
TaskState taskState)
Obtains the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given user. |
java.util.Collection<ActivityInstance<TaskInstance>> |
getTaskList(TaskState taskState)
Obtains the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the authenticated user. |
java.util.Set<ActivityInstance<TaskInstance>> |
getTasks(ProcessInstanceUUID instanceUUID)
Returns all records of task for the given process instance UUID. |
java.lang.Object |
getVariable(ActivityInstanceUUID activityUUID,
java.lang.String variableId)
Obtains a variable for the given activity and variable Id. |
java.util.Map<java.lang.String,java.lang.Object> |
getVariables(ActivityInstanceUUID activityUUID)
Obtains the activity variables (including global process and local activity variables) for the given activity UUID. |
Method Detail |
---|
java.util.Set<ProcessInstance> getProcessInstances()
getProcessInstances
in interface RemoteQueryRuntimeAPI
BonitaInternalException
- if an exception occurs.ProcessInstance getProcessInstance(ProcessInstanceUUID instanceUUID) throws InstanceNotFoundException
getProcessInstance
in interface 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 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(ActivityInstanceUUID activityUUID) throws ActivityNotFoundException
getActivityInstance
in interface 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.java.util.Set<ActivityInstance<ActivityBody>> getActivityInstances(ProcessInstanceUUID instanceUUID) throws InstanceNotFoundException
getActivityInstances
in interface 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 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 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 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
getTaskList
in interface 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
getTaskList
in interface RemoteQueryRuntimeAPI
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)
getTaskList
in interface 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)
Obtains the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED
for the given user.
If the task has been assigned to a user, only this user can get the task into the returned list.
Otherwise all the users that believe to the candidate list can get the task.
getTaskList
in interface RemoteQueryRuntimeAPI
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(ActivityInstanceUUID activityUUID, java.lang.String variableId) throws ActivityNotFoundException, VariableNotFoundException
getActivityInstanceVariable
in interface RemoteQueryRuntimeAPI
activityUUID
- the activity UUID.variableId
- the value of the Id attribute of the DataField element defined into the XPDL file.
Enumeration
or a plain String
).
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.util.Map<java.lang.String,java.lang.Object> getActivityInstanceVariables(ActivityInstanceUUID activityUUID) throws ActivityNotFoundException
getActivityInstanceVariables
in interface 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.lang.Object getVariable(ActivityInstanceUUID activityUUID, java.lang.String variableId) throws ActivityNotFoundException, VariableNotFoundException
getVariable
in interface RemoteQueryRuntimeAPI
activityUUID
- the activity UUID.variableId
- the value of the Id attribute of the DataField element defined into the XPDL file.
Enumeration
or a plain String})
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.util.Map<java.lang.String,java.lang.Object> getVariables(ActivityInstanceUUID activityUUID) throws InstanceNotFoundException, ActivityNotFoundException
getVariables
in interface 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.
InstanceNotFoundException
- if no recorded informations is found with the given instance UUID.
BonitaInternalException
- if an other exception occurs.java.lang.Object getProcessInstanceVariable(ProcessInstanceUUID instanceUUID, java.lang.String variableId) throws InstanceNotFoundException, VariableNotFoundException
getProcessInstanceVariable
in interface RemoteQueryRuntimeAPI
instanceUUID
- the instance UUID.variableId
- the variable id.
Enumeration
if the XPDL type is Enumerationtypes
).
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 RemoteQueryRuntimeAPI
instanceUUID
- the instance UUID.
InstanceNotFoundException
- if no instance has been found with the given instance UUID.
BonitaInternalException
- if an other exception occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |