|
||||||||||
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 | |
---|---|
org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.ActivityBody> |
getActivityInstance(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID)
Returns the record of the activity with the given activity UUID. |
java.util.Set<org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.ActivityBody>> |
getActivityInstances(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID)
Returns all records of activity for the given process instance UUID. |
java.util.Set<org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.ActivityBody>> |
getActivityInstances(org.ow2.bonita.facade.uuid.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(org.ow2.bonita.facade.uuid.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(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID)
Obtains the variables defined as local to the activity for the given activity UUID. |
org.ow2.bonita.facade.runtime.ProcessInstance |
getProcessInstance(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID)
Returns the record of the instance with the given UUID. |
java.util.Set<org.ow2.bonita.facade.runtime.ProcessInstance> |
getProcessInstances()
Returns all records of instance. |
java.util.Set<org.ow2.bonita.facade.runtime.ProcessInstance> |
getProcessInstances(org.ow2.bonita.facade.uuid.ProcessDefinitionUUID processUUID)
Returns all records of instance for the given process processDefinitionUUID. |
java.lang.Object |
getProcessInstanceVariable(org.ow2.bonita.facade.uuid.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(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID)
Obtains the process variables for the given process instance UUID. |
org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.TaskInstance> |
getTask(org.ow2.bonita.facade.uuid.TaskUUID taskUUID)
Returns the record of the task with the given task UUID. |
java.util.Collection<org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.TaskInstance>> |
getTaskList(org.ow2.bonita.facade.runtime.ActivityState taskState)
Obtains the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the authenticated user. |
java.util.Collection<org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.TaskInstance>> |
getTaskList(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID,
org.ow2.bonita.facade.runtime.ActivityState 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<org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.TaskInstance>> |
getTaskList(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID,
java.lang.String userId,
org.ow2.bonita.facade.runtime.ActivityState 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<org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.TaskInstance>> |
getTaskList(java.lang.String userId,
org.ow2.bonita.facade.runtime.ActivityState taskState)
Obtains the user tasks with state either READY or EXECUTING or SUSPENDED or FINISHED for the given user. |
java.util.Set<org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.TaskInstance>> |
getTasks(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID)
Returns all records of task for the given process instance UUID. |
java.lang.Object |
getVariable(org.ow2.bonita.facade.uuid.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(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID)
Obtains the activity variables (including global process and local activity variables) for the given activity UUID. |
Method Detail |
---|
java.util.Set<org.ow2.bonita.facade.runtime.ProcessInstance> getProcessInstances()
BonitaInternalException
- if an exception occurs.org.ow2.bonita.facade.runtime.ProcessInstance getProcessInstance(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<org.ow2.bonita.facade.runtime.ProcessInstance> getProcessInstances(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.org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.ActivityBody> getActivityInstance(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID) throws ActivityNotFoundException
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<org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.ActivityBody>> getActivityInstances(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<org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.ActivityBody>> getActivityInstances(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID, java.lang.String activityId) throws InstanceNotFoundException, ActivityNotFoundException
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
org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.TaskInstance> 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<org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.TaskInstance>> 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<org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.TaskInstance>> getTaskList(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID, org.ow2.bonita.facade.runtime.ActivityState taskState) throws InstanceNotFoundException
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<org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.TaskInstance>> getTaskList(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID, java.lang.String userId, org.ow2.bonita.facade.runtime.ActivityState taskState) throws InstanceNotFoundException
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<org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.TaskInstance>> getTaskList(org.ow2.bonita.facade.runtime.ActivityState taskState)
taskState
- the state
of the task.
BonitaInternalException
- if an other exception occurs.java.util.Collection<org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.TaskInstance>> getTaskList(java.lang.String userId, org.ow2.bonita.facade.runtime.ActivityState 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.
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(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID, java.lang.String variableId) throws ActivityNotFoundException, VariableNotFoundException
activityUUID
- the activity UUID.variableId
- the value of the Id attribute of the DataField element defined into the XPDL file.
Enumeration
,
a plain String
, a Boolean
, a Date
, a Long
or a Double
).
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(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID) throws ActivityNotFoundException
activityUUID
- the activity UUID.
Enumeration
,
a plain String
, a Boolean
, a Date
, a Long
or a Double
)).
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(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID, java.lang.String variableId) throws ActivityNotFoundException, VariableNotFoundException
activityUUID
- the activity UUID.variableId
- the value of the Id attribute of the DataField element defined into the XPDL file.
Enumeration
,
a plain String
, a Boolean
, a Date
, a Long
or a Double
).
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(org.ow2.bonita.facade.uuid.ActivityInstanceUUID activityUUID) throws InstanceNotFoundException, ActivityNotFoundException
activityUUID
- the activity UUID.
Enumeration
,
a plain String
, a Boolean
, a Date
, a Long
or a Double
).
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(org.ow2.bonita.facade.uuid.ProcessInstanceUUID instanceUUID, java.lang.String variableId) throws InstanceNotFoundException, VariableNotFoundException
instanceUUID
- the instance UUID.variableId
- the variable id.
Enumeration
,
a plain String
, a Boolean
, a Date
, a Long
or a Double
).
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(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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |