org.ow2.orchestra.facade
Interface QuerierRuntimeAPI

All Known Subinterfaces:

RemoteDeployerMBean

public interface QuerierRuntimeAPI

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.

Author:

Gael Lalire

Method Summary

java.util.Set<ActivityInstance>	findActivityInstances(ProcessInstanceUUID processUUID) Returns all records of activity for the given process instance UUID.
java.util.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.
java.util.Set<ProcessInstance>	findProcessInstances() Returns all records of instance.
java.util.Set<ProcessInstance>	findProcessInstances(ActivityState processInstanceState) Returns all records of instance for the given process state.
java.util.Set<ProcessInstance>	findProcessInstances(ProcessDefinitionUUID processDefinitionUUID) Returns all records of instance for the given process definition UUID.
java.util.Set<ProcessInstance>	findProcessInstances(ProcessDefinitionUUID processDefinitionUUID, ActivityState processInstanceState) Returns all records of instance for the given process definition UUID and the given process state.

Method Detail

findActivityInstances

java.util.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

java.util.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

java.util.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.

findProcessInstances

java.util.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

java.util.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

java.util.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'.