cz.ues.platform.process

Interface UESProcessExplorer

@UESComponent
@WebServiceAccessible(wspHandlerChain="ues/platform/process/UESProcessExplorerHandlerChain.xml")
public interface UESProcessExplorer

Component used for providing information about running processes. This component provides low level API for system usage (and for remote access using web commands and web services from thirdparty components which does not directly use client UES API libraries).

Since:

UES7-01

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<UESProcessAttributes>	getActiveProcessesByMainEntity(UESURI mainEntityUri) Returns list of active processes for given main entity.
java.util.List<UESProcessAttributes>	getDirectSubprocesses(UESURI processUri) Returns list of direct (first level) subprocesses of process with given UESURI.
UESProcessAttributes	getProcessAttributes(UESURI processUri) Returns object containing process attributes.
UESProcessProgress	getProcessProgress(UESURI processUri) Returns object representing state and progress of process with given UESURI.
UESProcessResult	getProcessResult(UESURI processUri, java.util.List<java.lang.String> eventCodes) Returns object representing result of process corresponding to given events.
java.util.List<UESProcessAttributes>	getSubprocesses(UESURI processUri) Returns list of all subprocesses of process with given UESURI.

Method Detail

getProcessProgress

UESProcessProgress getProcessProgress(UESURI processUri)
throws UESProcessExplorerRTException

Returns object representing state and progress of process with given UESURI.

Parameters:

processUri - UESURI of process

Returns:

Process progress or null if no such process exists

Throws:

UESProcessExplorerRTException - In case reading of process progress fails

Since:

UES7-02

getProcessAttributes

UESProcessAttributes getProcessAttributes(UESURI processUri)
throws UESProcessExplorerRTException

Returns object containing process attributes.

Parameters:

processUri - UESURI of process

Returns:

Process attributes or null if no such process exists

Throws:

UESProcessExplorerRTException - In case reading of process attributes fails

Since:

UES7-02

getProcessResult

UESProcessResult getProcessResult(UESURI processUri,
java.util.List<java.lang.String> eventCodes)
throws UESProcessExplorerRTException

Returns object representing result of process corresponding to given events. Events are specified as list of event codes regular expressions. When no events are specified, method returns final result of given process. In case given process does not exist or no event matches given parameters, null is returned as result.

Parameters:

processUri - UESURI of process

eventCodes - Optional list of event codes regular expressions

Returns:

Result matching given criteria or null if no such result exists

Throws:

UESProcessExplorerRTException - In case obtaining of process result fails

Since:

UES7-02

getActiveProcessesByMainEntity

java.util.List<UESProcessAttributes> getActiveProcessesByMainEntity(UESURI mainEntityUri)
throws UESProcessExplorerRTException

Returns list of active processes for given main entity.

Parameters:

mainEntityUri - UESURI of main entity

Returns:

List of active processes

Throws:

UESProcessExplorerRTException - In case reading of process list fails

Since:

UES7-04

getSubprocesses

java.util.List<UESProcessAttributes> getSubprocesses(UESURI processUri)
throws UESProcessExplorerRTException

Returns list of all subprocesses of process with given UESURI.

Parameters:

processUri - UESURI of process

Returns:

List of all subprocesses

Throws:

UESProcessExplorerRTException - In case reading of process list fails

Since:

UES7-02

getDirectSubprocesses

java.util.List<UESProcessAttributes> getDirectSubprocesses(UESURI processUri)
throws UESProcessExplorerRTException

Returns list of direct (first level) subprocesses of process with given UESURI.

Parameters:

processUri - UESURI of process

Returns:

List of direct subprocesses

Throws:

UESProcessExplorerRTException - In case reading of process list fails

Since:

UES7-02