|
|||||||||
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 | |
---|---|
java.util.Set<ActivityInst<ActivityBody>> |
getActivities(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID)
Returns all records of activity for the given instance UUID. |
java.util.Set<ActivityInst<ActivityBody>> |
getActivities(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID,
java.lang.String activityId)
|
ActivityInst<ActivityBody> |
getActivity(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID)
|
ActivityInst<ActivityBody> |
getActivity(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID,
java.lang.String activityId)
|
ActivityInst<ActivityBody> |
getActivity(org.ow2.bonita.facade.uuid.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.lang.Object |
getActivityVariable(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID,
java.lang.String variableId)
|
java.lang.Object |
getActivityVariable(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID,
java.lang.String activityId,
java.lang.String variableId)
Obtain a variable for the given activity and instance. |
java.lang.Object |
getActivityVariable(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID,
java.lang.String activityId,
java.lang.String iterationId,
java.lang.String variableId)
|
java.util.Map<java.lang.String,java.lang.Object> |
getActivityVariableDefinitions(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processUUID,
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> |
getActivityVariables(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID)
|
java.util.Map<java.lang.String,java.lang.Object> |
getActivityVariables(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID,
java.lang.String activityId)
Obtain the activity variables (including global process and local activity variables) for the given instance and activity. |
java.util.Map<java.lang.String,java.lang.Object> |
getActivityVariables(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID,
java.lang.String activityId,
java.lang.String iterationId)
|
ProcessInst |
getInstance(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID)
Returns the record of the instance with the given UUID. |
java.util.Set<ProcessInst> |
getInstances(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processUUID)
Returns all records of instance for the given process processDefinitionUUID. |
java.lang.Object |
getInstanceVariable(org.ow2.bonita.facade.uuid.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> |
getInstanceVariables(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID)
Obtain the process variables for the given instance. |
java.util.Map<java.lang.String,java.lang.Object> |
getProcessVariableDefinitions(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processUUID)
Obtain the variable definitions of the process for the given process. |
ActivityInst<TaskInst> |
getTask(org.ow2.bonita.facade.uuid.TaskUUID taskUUID)
Returns the record of the task with the given task UUID. |
java.util.Collection<ActivityInst<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<ActivityInst<TaskInst>> |
getTaskList(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID,
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.Set<ActivityInst<TaskInst>> |
getTasks(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID)
Returns all records of task for the given instance UUID. |
Method Detail |
---|
ProcessInst getInstance(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID) throws InstanceNotFoundException
instanceUUID
- the instance UUID.
InstanceNotFoundException
- if no instance has been found with the given instance UUID.
BonitaInternalException
- if an exception occurs.java.util.Set<ProcessInst> getInstances(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processUUID) throws ProcessNotFoundException
processUUID
- the process definition UUID.
ProcessNotFoundException
- if no process has been found with the given process UUID.
BonitaInternalException
- if an exception occurs.ActivityInst<ActivityBody> getActivity(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID, java.lang.String activityId, java.lang.String iterationId) throws InstanceNotFoundException, ActivityNotFoundException
instanceUUID
- the instance processDefinitionUUID.activityId
- the activity Id as specified in the xpdl file.iterationId
- processDefinitionUUID of the iteration
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.ActivityInst<ActivityBody> getActivity(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID) throws ActivityNotFoundException
ActivityNotFoundException
ActivityInst<ActivityBody> getActivity(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID, java.lang.String activityId) throws InstanceNotFoundException, ActivityNotFoundException, ActivityInIterationException
InstanceNotFoundException
ActivityNotFoundException
ActivityInIterationException
java.util.Set<ActivityInst<ActivityBody>> getActivities(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID) throws InstanceNotFoundException
instanceUUID
- the instance UUID.
InstanceNotFoundException
- if no instance has been found with the given instance UUID.
BonitaInternalException
- if an exception occurs.java.util.Set<ActivityInst<ActivityBody>> getActivities(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID, java.lang.String activityId) throws InstanceNotFoundException, ActivityNotFoundException
InstanceNotFoundException
ActivityNotFoundException
ActivityInst<TaskInst> getTask(org.ow2.bonita.facade.uuid.TaskUUID taskUUID) throws TaskNotFoundException
taskUUID
- the task UUID.
TaskNotFoundException
- if no task has been found with the given task UUID.
BonitaInternalException
- if an exception occurs.java.util.Set<ActivityInst<TaskInst>> getTasks(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID) throws InstanceNotFoundException
instanceUUID
- the instance UUID.
InstanceNotFoundException
- if no instance has been found with the given instance UUID.
BonitaInternalException
- if an exception occurs.java.util.Collection<ActivityInst<TaskInst>> getTaskList(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID, org.ow2.bonita.util.Constants.TaskState taskState) throws InstanceNotFoundException
Obtain the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given instance.
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<ActivityInst<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 getActivityVariable(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID, java.lang.String activityId, java.lang.String variableId) throws InstanceNotFoundException, ActivityNotFoundException, ActivityInIterationException, VariableNotFoundException
instanceUUID
- the instance UUID.activityId
- the activity id as specified in the xpdl file.variableId
- the variable id as specified in 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.
VariableNotFoundException
- if no variable is found with the given id.
BonitaInternalException
- if an other exception occurs.
ActivityInIterationException
java.lang.Object getActivityVariable(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID, java.lang.String variableId) throws ActivityNotFoundException, VariableNotFoundException
ActivityNotFoundException
VariableNotFoundException
java.lang.Object getActivityVariable(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID, java.lang.String activityId, java.lang.String iterationId, java.lang.String variableId) throws InstanceNotFoundException, ActivityNotFoundException, VariableNotFoundException
InstanceNotFoundException
ActivityNotFoundException
VariableNotFoundException
java.util.Map<java.lang.String,java.lang.Object> getActivityVariables(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID, java.lang.String activityId) throws ActivityNotFoundException, ActivityInIterationException, InstanceNotFoundException
instanceUUID
- the instance UUID.activityId
- the activity id as specified in 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.
BonitaInternalException
- if an other exception occurs.
ActivityInIterationException
InstanceNotFoundException
java.util.Map<java.lang.String,java.lang.Object> getActivityVariables(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID) throws ActivityNotFoundException
ActivityNotFoundException
java.util.Map<java.lang.String,java.lang.Object> getActivityVariables(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID, java.lang.String activityId, java.lang.String iterationId) throws ActivityNotFoundException, InstanceNotFoundException
ActivityNotFoundException
InstanceNotFoundException
java.lang.Object getInstanceVariable(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID, java.lang.String variableId) throws InstanceNotFoundException, VariableNotFoundException
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> getInstanceVariables(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID) throws InstanceNotFoundException
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(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processUUID, java.lang.String activityId) throws ProcessNotFoundException, ActivityNotFoundException
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(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processUUID) throws ProcessNotFoundException
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 |