cz.ues.platform.process

Interface UESProcessController

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

Component used for controlling of UES Process process lifecycle. 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
void	allocate(UESURI processUri, UESMessage message) Initializes process by allocating existing process instance and associating it with current PCB.
UESURI	create(UESURI useCaseUri, UESURI mainEntityUri, UESURI parentProcessUri, UESMessage message) Creates new instance of process and associates it with executed use case.
void	done(UESURI processUri, UESProcessState exitState, UESProcessEvent processEvent) Sets result of process and marks it as completed.
void	fireEvent(UESURI processUri, UESProcessEvent processEvent) Method is used to send events from process.
UESURI	getCurrentProcessUri() Returns UESURI of currently active process (process associated with active PCB).
void	release(UESURI processUri, UESProcessState exitState, UESProcessEvent processEvent) Finalizes process execution.
void	setContextParameter(UESURI processUri, java.lang.String name, java.lang.String value) Sets parameter on process context.
void	start(UESURI processUri, UESMessage message, int totalWorkUnits) User initialization of process representing beginning of use case execution.

Method Detail

create

UESURI create(UESURI useCaseUri,
UESURI mainEntityUri,
UESURI parentProcessUri,
UESMessage message)
throws UESProcessControllerRTException

Creates new instance of process and associates it with executed use case. This instance of process cannot be further used for until allocate method is called. This method should be invoked automatically by corresponding container and should not be normally used.

Parameters:

useCaseUri - UESURI of use case executed in process.

mainEntityUri - UESURI of main entity associated with process.

parentProcessUri - UESURI of parent process (if parent process URI is not given, process monitoring will be initialized without reference to parent process and thus this subprocess will not be accessible from parent process)

message - Optional message announcing process creation

Returns:

UESURI of process

Throws:

UESProcessControllerRTException - In case creating of process fails

Since:

UES7-02

setContextParameter

void setContextParameter(UESURI processUri,
java.lang.String name,
java.lang.String value)
throws UESProcessControllerRTException

Sets parameter on process context. Process context is mainly used to pass additional parameters to process event listeners with each fired process event.

Parameters:

processUri - UESURI of process

name - Name of context parameter

value - Value of context parameter

Throws:

UESProcessControllerRTException - In case initialization of context is not possible

Since:

UES7-02

allocate

void allocate(UESURI processUri,
UESMessage message)
throws UESProcessControllerRTException

Initializes process by allocating existing process instance and associating it with current PCB. Method should be invoked automatically by corresponding container and should not be normally used. Method can be invoked only once per process (only one process can be associated with each PCB).

Parameters:

processUri - UESURI of process

message - Optional message announcing process allocation

Throws:

UESProcessControllerRTException - In case allocating of process fails

Since:

UES7-02

getCurrentProcessUri

UESURI getCurrentProcessUri()

Returns UESURI of currently active process (process associated with active PCB).

Returns:

UESURI of process

Since:

UES7-02

start

void start(UESURI processUri,
UESMessage message,
int totalWorkUnits)

User initialization of process representing beginning of use case execution. Method also provides additional informations which are usually unavailable for execution container and cannot be automatically set. If method is not invoked, it will be invoked automatically with default values on first fired event from process.

Parameters:

processUri - UESURI of process UESURI of process

message - Optional message announcing process/use case start

totalWorkUnits - Total work units to be done by process/use case

Since:

UES7-02

fireEvent

void fireEvent(UESURI processUri,
UESProcessEvent processEvent)

Method is used to send events from process. Based on event type, they are used only to inform user about process progress, or can be consumed by other processes and system components. Event can be also fired with UESURI of related object, which may represent partial result of running process (and thus can be further processes by components listening to our events). It is usually either object or forwarding use case, but can be anything else representable by UESURI (concrete meaning of value should be documented in use case specification).

Parameters:

processUri - UESURI of process

processEvent - Fired event (instance of UESProcessEvent)

Since:

UES7-02

done

void done(UESURI processUri,
UESProcessState exitState,
UESProcessEvent processEvent)

Sets result of process and marks it as completed. Process can be ended in one of following states: FINISHED (successfully), FAILED (with problems) or ERROR (not completely finished). Result of finished process is represented by resultObject. It is usually either object or forwarding use case, but can be anything else representable by UESURI (concrete meaning of value should be documented in use case specification).

Parameters:

processUri - UESURI of process

exitState - Exit state

processEvent - Process event to be fired instead of system default event (not all event attributes can be overloaded)

Since:

UES7-02

release

void release(UESURI processUri,
UESProcessState exitState,
UESProcessEvent processEvent)

Finalizes process execution. Method should be invoked automatically by corresponding container after exiting use case realization block and should not be normally used.

Parameters:

processUri - UESURI of process

exitState - Exit state (state is used for system invocation of done method in case it was not called within use case)

processEvent - Process event to be fired instead of system default event (not all event attributes can be overloaded)

Since:

UES7-02