org.ow2.orchestra.facade
Interface QueryRuntimeAPI

All Known Subinterfaces:

RemoteDeployerMBean

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.

Author:

Gael Lalire

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

findActivityInstances

Set<ActivityInstance> findActivityInstances(ProcessInstanceUUID processUUID)
                                            throws InstanceNotFoundException

Returns all records of activity for the given process instance UUID. An empty set is returned if no instance is found.

Parameters:

processUUID - the uuid of the process instance.

Returns:

a set of activity instances corresponding to processUUID.

Throws:

InstanceNotFoundException - if processUUID cannot be found

findActivityInstances

Set<ActivityInstance> findActivityInstances(ProcessInstanceUUID processUUID,
                                            ActivityState activityState)
                                            throws InstanceNotFoundException

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.

Parameters:

processUUID - the uuid of the process instance.

activityState - the state of activities ("RUNNING" or "RUNNED").

Returns:

a set of activity instances corresponding to processUUID and state 'active'.

Throws:

InstanceNotFoundException - if processUUID cannot be found

findProcessInstances

Set<ProcessInstance> findProcessInstances()

Returns all records of instance.
An empty set is returned if no instance is found.

Returns:

a set of all process instances.

findProcessInstancesPage

PagedResult<ProcessInstance> findProcessInstancesPage(Criteria<ProcessInstance> criteria)

Returns a page of ProcessInstance corresponding to given Criteria.

Parameters:

criteria - Criteria used to specify the PagedResult to be returned

Returns:

Returns a PagedResult according to given Criteria.

findProcessInstances

Set<ProcessInstance> findProcessInstances(ProcessDefinitionUUID processDefinitionUUID)
                                          throws ProcessNotFoundException

Returns all records of instance for the given process definition UUID.
An empty set is returned if no instance is found.

Parameters:

processDefinitionUUID - the uuid of the process definition

Returns:

a set of process instances corresponding to processDefinitionUUID

Throws:

ProcessNotFoundException

findProcessInstances

Set<ProcessInstance> findProcessInstances(ProcessDefinitionUUID processDefinitionUUID,
                                          ActivityState processInstanceState)
                                          throws ProcessNotFoundException

Returns all records of instance for the given process definition UUID and the given process state. An empty set is returned if no instance is found.

Parameters:

processDefinitionUUID - the uuid of the process definition

processInstanceState - the state of process instances ("RUNNING" or "RUNNED").

Returns:

a set of process instances corresponding to processDefinitionUUID and state 'active'.

Throws:

ProcessNotFoundException

findProcessInstances

Set<ProcessInstance> findProcessInstances(ActivityState processInstanceState)

Returns all records of instance for the given process state. An empty set is returned if no instance is found.

Parameters:

processInstanceState - state of process instances ("RUNNING" or "RUNNED").

Returns:

a set of process instances corresponding to state 'active'.

getProcessInstance

ProcessInstance getProcessInstance(ProcessInstanceUUID processInstanceUUID)
                                   throws InstanceNotFoundException

Returns recorded instance data for the given process instance UUID.

Parameters:

processInstanceUUID - the uuid of the process instance.

Returns:

the process instance uuid

Throws:

InstanceNotFoundException - if instance cannot be found

getActivityInstance

ActivityInstance getActivityInstance(ActivityInstanceUUID activityInstanceUUID)
                                     throws ActivityInstanceNotFoundException

Returns recorded instance data for the given activity instance UUID.

Parameters:

activityInstanceUUID - the uuid of the activity instance.

Returns:

the activity definition

Throws:

ActivityInstanceNotFoundException - if activity instance cannot be found