cz.ues.platform.commons.pcb.monitor.internal

Interface UESProcessMonitor

All Superinterfaces:

UESProcessMonitor

@UESComponent
public interface UESProcessMonitor
extends UESProcessMonitor

Internal API of Process Monitor containing methods for initialization and finalization of process monitoring. This API is not meant for public use. Developers should use UESProcessMonitor instead.

Since:

UES6-00

See Also:

UESProcessMonitor

Field Summary

Fields inherited from interface cz.ues.platform.commons.pcb.monitor.UESProcessMonitor

MONITOR_DISABLED, UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel(MessageCode aMsgCode, java.lang.String aMsg, java.lang.Object... aParams) Finishes monitoring of process as canceled.
void	finish(MessageCode aMsgCode, java.lang.String aMsg, java.lang.Exception aException, java.lang.Object... aParams) Finalizes monitoring of process.
void	start(MessageCode aMsgCode, java.lang.String aMsg, java.lang.Object... aParams) Starts monitoring of process.

Methods inherited from interface cz.ues.platform.commons.pcb.monitor.UESProcessMonitor

beginProcess, done, notifyInfo, notifyWarning, progress, setProperties

Method Detail

start

void start(MessageCode aMsgCode,
java.lang.String aMsg,
java.lang.Object... aParams)

Starts monitoring of process. Without invoke of this method it is not possible to use methods from public API (Their invocation does not cause failure, but call is ignored).

Parameters:

aMsgCode - Code of message used for notification

aMsg - Notification message

aParams - Parameters of notification message

Since:

UES6-00

finish

void finish(MessageCode aMsgCode,
java.lang.String aMsg,
java.lang.Exception aException,
java.lang.Object... aParams)

Finalizes monitoring of process. After invocation of this method, start method must be called again in order to start another monitoring session.

Parameters:

aMsgCode - Code of message used for notification

aMsg - Notification message

aException - Instance of exception (may be null) thrown from inner logic. In case exception is not null process is always finished in FAILED state. If exception is null, state given in done method is preserved.

aParams - Parameters of notification message

Since:

UES6-00

cancel

void cancel(MessageCode aMsgCode,
java.lang.String aMsg,
java.lang.Object... aParams)

Finishes monitoring of process as canceled. After invocation of this method, start method must be called again in order to start another monitoring session.

Parameters:

aMsgCode - Code of message used for notification

aMsg - Notification message

aParams - Parameters of notification message

Since:

UES6-00