org.ow2.orchestra.facade
Interface QueryDefinitionAPI

All Known Subinterfaces:

RemoteDeployerMBean

public interface QueryDefinitionAPI

Getters on workflow recorded data.
Operations in this API applies to definition entities managed by Nova Orchestra such as:
process and activities.
Returned records are issued from recorded definition informations.

This API cannot be used when monitoring is disabled.

Author:

Guillaume Porcher

Method Summary

Set<ActivityDefinition>	findActivityDefinitions(ProcessDefinitionUUID processUUID) Returns all records of activity for the given process definition UUID.
List<ProcessDefinition>	findProcessDefinitions() Returns the list of processes.
List<ProcessDefinition>	findProcessDefinitions(ProcessState state) Returns the list of processes with the given state.
List<ProcessDefinition>	findProcessDefinitions(QName processQName) Returns the list of processes with the given qname.
List<ProcessDefinition>	findProcessDefinitions(QName processQName, ProcessState state) Returns the list of processes with the given state and qname.
ActivityDefinition	getActivityDefinition(ActivityDefinitionUUID activityDefinitionUUID) Returns recorded definition data for the given activity definition UUID.
ProcessDefinition	getProcessDefinition(ProcessDefinitionUUID processUUID) Returns recorded definition data for the given process definition UUID.
byte[]	getProcessResource(ProcessDefinitionUUID processUUID, String resourceName) Returns recorded resource content for the given process definition UUID.

Method Detail

findProcessDefinitions

List<ProcessDefinition> findProcessDefinitions()

Returns the list of processes.

Returns:

The list of process definition for processes.

findProcessDefinitions

List<ProcessDefinition> findProcessDefinitions(ProcessState state)

Returns the list of processes with the given state.

Parameters:

state: - state of processes

Returns:

The list of process definition for processes.

findProcessDefinitions

List<ProcessDefinition> findProcessDefinitions(QName processQName,
                                               ProcessState state)

Returns the list of processes with the given state and qname.

Parameters:

processQName - qualified name of the process

state - state of processes

Returns:

The list of process definition for processes.

findProcessDefinitions

List<ProcessDefinition> findProcessDefinitions(QName processQName)

Returns the list of processes with the given qname.

Parameters:

processQName - qualified name of the process

state: - state of processes

Returns:

The list of process definition for processes.

getProcessDefinition

ProcessDefinition getProcessDefinition(ProcessDefinitionUUID processUUID)
                                       throws ProcessNotFoundException

Returns recorded definition data for the given process definition UUID.

Parameters:

processUUID - the uuid of the process definition.

Returns:

the process definition

Throws:

ProcessNotFoundException - if processUUID cannot be found

getActivityDefinition

ActivityDefinition getActivityDefinition(ActivityDefinitionUUID activityDefinitionUUID)
                                         throws ActivityNotFoundException

Returns recorded definition data for the given activity definition UUID.

Parameters:

activityDefinitionUUID - the uuid of the activity definition.

Returns:

the activity definition

Throws:

ActivityNotFoundException - if activityDefinitionUUID cannot be found

findActivityDefinitions

Set<ActivityDefinition> findActivityDefinitions(ProcessDefinitionUUID processUUID)
                                                throws ProcessNotFoundException

Returns all records of activity for the given process definition UUID.

Parameters:

processUUID - the uuid of the process definition.

Returns:

a set of activity definition corresponding to processUUID.

Throws:

ProcessNotFoundException - if processUUID cannot be found

getProcessResource

byte[] getProcessResource(ProcessDefinitionUUID processUUID,
                          String resourceName)
                          throws ProcessNotFoundException

Returns recorded resource content for the given process definition UUID.

Parameters:

processUUID - the uuid of the process definition.

resourceName - the name of the resource

Returns:

the process resource

Throws:

ProcessNotFoundException - if processUUID cannot be found