org.ow2.orchestra.facade
Interface RuntimeAPI


public interface RuntimeAPI

Get information about processes and instances from the engine repository.
This API can be used even when monitoring is disabled.

Author:
Guillaume Porcher

Method Summary
 Set<ActivityDefinitionData> getActivityDefinitions(ProcessDefinitionUUID processUUID)
          Get information about a process activities.
 ProcessDefinitionData getProcess(ProcessDefinitionUUID processUUID)
          Get information about a process.
 Set<ProcessDefinitionData> getProcesses()
           
 ProcessInstanceData getProcessInstance(ProcessInstanceUUID processInstanceUUID)
          Get information about a process instance.
 Set<ProcessInstanceData> getProcessInstances()
           
 Set<ProcessInstanceData> getProcessInstances(ProcessDefinitionUUID processDefinitionUUID)
          Get information about the instances of a process
 

Method Detail

getProcesses

Set<ProcessDefinitionData> getProcesses()
Returns:
the list of process currently in the engine repository.

getProcess

ProcessDefinitionData getProcess(ProcessDefinitionUUID processUUID)
                                 throws ProcessNotFoundException
Get information about a process.

Parameters:
processUUID - UUID of the process
Returns:
information on process with UUID processUUID
Throws:
ProcessNotFoundException - if no process with the given UUID exists in the repository.

getActivityDefinitions

Set<ActivityDefinitionData> getActivityDefinitions(ProcessDefinitionUUID processUUID)
                                                   throws ProcessNotFoundException
Get information about a process activities.

Parameters:
processUUID - UUID of the process
Returns:
a list of information on activities of the process with UUID processUUID
Throws:
ProcessNotFoundException - if no process with the given UUID exists in the repository.

getProcessInstances

Set<ProcessInstanceData> getProcessInstances()
Returns:
the list of process instances currently in the engine repository.

getProcessInstances

Set<ProcessInstanceData> getProcessInstances(ProcessDefinitionUUID processDefinitionUUID)
                                             throws ProcessNotFoundException
Get information about the instances of a process

Parameters:
processDefinitionUUID - UUID of the process
Returns:
a list of information on instances of the process with UUID processDefinitionUUID
Throws:
ProcessNotFoundException - if no process with the given UUID exists in the repository.

getProcessInstance

ProcessInstanceData getProcessInstance(ProcessInstanceUUID processInstanceUUID)
                                       throws InstanceNotFoundException
Get information about a process instance.

Parameters:
processInstanceUUID - UUID of the instance
Returns:
information on process instance with UUID processInstanceUUID
Throws:
InstanceNotFoundException - if no process instance with the given UUID exists in the repository.


Copyright © 2011 OW2 Consortium. All Rights Reserved.