|
||||||||||
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 runtime entities managed by Nova Orchestra
such as:
process instances and activities.
Returned records are issued from recorded runtime informations.
This API cannot be used when monitoring is disabled.
Method Summary | |
---|---|
Set<ActivityInstance> |
findActivityInstances(ProcessInstanceUUID processUUID)
Returns all records of activity for the given process instance UUID. |
Set<ActivityInstance> |
findActivityInstances(ProcessInstanceUUID processUUID,
ActivityState activityState)
Returns all records of activity for the given process instance UUID and the given activity state An empty set is returned if no instance is found. |
Set<ProcessInstance> |
findProcessInstances()
Returns all records of instance. |
Set<ProcessInstance> |
findProcessInstances(ActivityState processInstanceState)
Returns all records of instance for the given process state. |
Set<ProcessInstance> |
findProcessInstances(ProcessDefinitionUUID processDefinitionUUID)
Returns all records of instance for the given process definition UUID. |
Set<ProcessInstance> |
findProcessInstances(ProcessDefinitionUUID processDefinitionUUID,
ActivityState processInstanceState)
Returns all records of instance for the given process definition UUID and the given process state. |
PagedResult<ProcessInstance> |
findProcessInstancesPage(Criteria<ProcessInstance> criteria)
Returns a page of ProcessInstance corresponding to given
Criteria . |
ActivityInstance |
getActivityInstance(ActivityInstanceUUID activityInstanceUUID)
Returns recorded instance data for the given activity instance UUID. |
ProcessInstance |
getProcessInstance(ProcessInstanceUUID processInstanceUUID)
Returns recorded instance data for the given process instance UUID. |
Method Detail |
---|
Set<ActivityInstance> findActivityInstances(ProcessInstanceUUID processUUID) throws InstanceNotFoundException
processUUID
- the uuid of the process instance.
InstanceNotFoundException
- if processUUID cannot be foundSet<ActivityInstance> findActivityInstances(ProcessInstanceUUID processUUID, ActivityState activityState) throws InstanceNotFoundException
processUUID
- the uuid of the process instance.activityState
- the state of activities ("RUNNING" or "RUNNED").
InstanceNotFoundException
- if processUUID cannot be foundSet<ProcessInstance> findProcessInstances()
PagedResult<ProcessInstance> findProcessInstancesPage(Criteria<ProcessInstance> criteria)
ProcessInstance
corresponding to given
Criteria
.
criteria
- Criteria used to specify the PagedResult to be
returned
Set<ProcessInstance> findProcessInstances(ProcessDefinitionUUID processDefinitionUUID) throws ProcessNotFoundException
processDefinitionUUID
- the uuid of the process definition
ProcessNotFoundException
Set<ProcessInstance> findProcessInstances(ProcessDefinitionUUID processDefinitionUUID, ActivityState processInstanceState) throws ProcessNotFoundException
processDefinitionUUID
- the uuid of the process definitionprocessInstanceState
- the state of process instances ("RUNNING" or
"RUNNED").
ProcessNotFoundException
Set<ProcessInstance> findProcessInstances(ActivityState processInstanceState)
processInstanceState
- state of process instances ("RUNNING" or
"RUNNED").
ProcessInstance getProcessInstance(ProcessInstanceUUID processInstanceUUID) throws InstanceNotFoundException
processInstanceUUID
- the uuid of the process instance.
InstanceNotFoundException
- if instance cannot be foundActivityInstance getActivityInstance(ActivityInstanceUUID activityInstanceUUID) throws ActivityInstanceNotFoundException
activityInstanceUUID
- the uuid of the activity instance.
ActivityInstanceNotFoundException
- if activity instance cannot be
found
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |