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

Class MonitorContext

java.lang.Object

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

@UESComponent
public class MonitorContext
extends java.lang.Object

Monitor context used for storing information about process state and progress on process environment.

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CANCELED Name of canceled parameter.
static java.lang.String	DONE_MSG Name of done message parameter.
static java.lang.String	EXIT_STATE Name of exit state parameter.
static java.lang.String	INITIALIZED Name of initialized flag.
static java.lang.String	MONITOR_DISABLED Name of parameter used for disabling of process monitoring.
private UESProcessManager	prMng Instance of process manager.
static java.lang.String	TUNITS Name of total units parameter.
static java.lang.String	UNITS Name of units parameter.

Constructor Summary

Constructors

Constructor and Description
MonitorContext()

Method Summary

Methods

Modifier and Type	Method and Description
Message	getDoneMessage() Gets done message of process.
UESExitState	getExitState() Gets exit state of process.
java.lang.Integer	getTotalUnits() Gets total units (amount of work) to be done.
java.lang.Integer	getUnits() Gets units (amount of work) done so far.
boolean	isCanceled() Checks if process is canceled.
boolean	isDisabled() Checks if process monitoring is disabled.
boolean	isInitialized() Checks if process monitor is initialized and ready for monitoring.
void	removeContext() Removes all context parameters from process environment.
void	setCanceled() Sets process as canceled.
void	setDisabled() Disable process monitoring.
void	setDoneMessage(Message aValue) Sets done message of process.
void	setExitState(UESExitState aValue) Sets exit state of process.
void	setInitialized() Marks process monitor as initialized and ready for monitoring.
void	setTotalUnits(java.lang.Integer aValue) Sets total units (amount of work) to be done.
void	setUnits(java.lang.Integer aValue) Sets units (amount of work) done so far.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INITIALIZED

public static final INITIALIZED

Name of initialized flag.

See Also:

Constant Field Values

TUNITS

public static final TUNITS

Name of total units parameter.

See Also:

Constant Field Values

UNITS

public static final UNITS

Name of units parameter.

See Also:

Constant Field Values

EXIT_STATE

public static final EXIT_STATE

Name of exit state parameter.

See Also:

Constant Field Values

DONE_MSG

public static final DONE_MSG

Name of done message parameter.

See Also:

Constant Field Values

CANCELED

public static final CANCELED

Name of canceled parameter.

See Also:

Constant Field Values

MONITOR_DISABLED

public static final MONITOR_DISABLED

Name of parameter used for disabling of process monitoring.

See Also:

Constant Field Values

prMng

@Inject

private prMng

Instance of process manager.

Constructor Detail

MonitorContext

public MonitorContext()

Method Detail

setInitialized

public void setInitialized()

Marks process monitor as initialized and ready for monitoring.

Since:

UES6-00

isInitialized

public boolean isInitialized()

Checks if process monitor is initialized and ready for monitoring.

Returns:

True if process monitor is initialized, else false

Since:

UES6-00

setTotalUnits

public void setTotalUnits(java.lang.Integer aValue)

Sets total units (amount of work) to be done.

Parameters:

aValue - Total units

Since:

UES6-00

getTotalUnits

public java.lang.Integer getTotalUnits()

Gets total units (amount of work) to be done.

Returns:

Total units

Since:

UES6-00

setUnits

public void setUnits(java.lang.Integer aValue)

Sets units (amount of work) done so far.

Parameters:

aValue - Units done so far

Since:

UES6-00

getUnits

public java.lang.Integer getUnits()

Gets units (amount of work) done so far.

Returns:

Units done so far

Since:

UES6-00

setExitState

public void setExitState(UESExitState aValue)

Sets exit state of process.

Parameters:

aValue - Exit state

Since:

UES6-00

getExitState

public UESExitState getExitState()

Gets exit state of process.

Returns:

Exit state

Since:

UES6-00

setDoneMessage

public void setDoneMessage(Message aValue)

Sets done message of process.

Parameters:

aValue - Message

Since:

UES6-00

getDoneMessage

public Message getDoneMessage()

Gets done message of process.

Returns:

Message

Since:

UES6-00

setCanceled

public void setCanceled()

Sets process as canceled.

Since:

UES6-00

isCanceled

public boolean isCanceled()

Checks if process is canceled.

Returns:

True if process is canceled

Since:

UES6-00

setDisabled

public void setDisabled()

Disable process monitoring.

Since:

UES7-01

isDisabled

public boolean isDisabled()

Checks if process monitoring is disabled.

Returns:

True if process monitoring is disabled

Since:

UES7-01

removeContext

public void removeContext()

Removes all context parameters from process environment.

Since:

UES6-00