Monitor

Method Summary
long	getAverageTime() Returns the average time between each start and stop of the timer in milliseconds.
long	getMaxTime() Returns the maximum time among all of the start and stop of the timer in milliseconds.
int	getMaxTimeout() Returns the maximum allowed timeout set by the activation key.
int	getRemainingTime() Returns the approximate remaining time in seconds.
int	getTimeout() Returns the timeout setting.
boolean	isAverageRemaining() Returns true if the time remaining in the workflow engine is greater than the average timer recording.
boolean	isMaxRemaining() Returns true if the time remaining in the workflow engine is greater than the maximum timer recording.
boolean	isTimeRemaining(int seconds) Returns true if the timeout remaining exceeds the buffer (seconds).
int	setMaxTimeout() Sets the timeout to maximum allowed and returns it
	setQueryTimeout(int timeout) Sets the global timeout for the dataset queries. Anything longer than this time will trigger a subscription notice. Minimum is 2 seconds and maximum is 10 seconds.
	setTimeout(int timeout) Sets the timeout for the monitor in seconds. Default and minimum is 10. Maximum is determined by the activation key. This method is called only once per workflow cycle. Subsequent calls are ignored.
	startTimer() Starts the timer
long	stopTimer() Stops the timer and returns the time in milliseconds. You should call start timer first else this will return 0.
String	toString() Returns a description of this object.

Method Detail

long getAverageTime()

Returns the average time between each start and stop of the timer in milliseconds.

Returns: long

Since: 12-26-2024

top

long getMaxTime()

Returns the maximum time among all of the start and stop of the timer in milliseconds.

Returns: long

Since: 12-26-2024

top

int getMaxTimeout()

Returns the maximum allowed timeout set by the activation key.

Returns: int

Since: 01-04-2010

top

int getRemainingTime()

Returns the approximate remaining time in seconds.

Returns: int

Since: 01-04-2010

top

int getTimeout()

Returns the timeout setting.

Returns: int

Since: 01-04-2010

top

boolean isAverageRemaining()

Returns true if the time remaining in the workflow engine is greater than the average timer recording.

Returns: boolean

Since: 12-26-2024

top

boolean isMaxRemaining()

Returns true if the time remaining in the workflow engine is greater than the maximum timer recording.

Returns: boolean

Since: 12-26-2024

top

boolean isTimeRemaining(int seconds)

Returns true if the timeout remaining exceeds the buffer (seconds).

Parameters:

int seconds

Returns: boolean

Since: 01-04-2010

top

int setMaxTimeout()

Sets the timeout to maximum allowed and returns it

Returns: int

Since: 11-07-2018

top

setQueryTimeout(int timeout)

Sets the global timeout for the dataset queries. Anything longer than this time will trigger a subscription notice. Minimum is 2 seconds and maximum is 10 seconds.

Parameters:

int timeout

Since: 11-07-2018

top

setTimeout(int timeout)

Sets the timeout for the monitor in seconds. Default and minimum is 10. Maximum is determined by the activation key. This method is called only once per workflow cycle. Subsequent calls are ignored.

Parameters:

int timeout

Since: 01-04-2010

top

startTimer()

Starts the timer

Since: 12-26-2024

top

long stopTimer()

Stops the timer and returns the time in milliseconds. You should call start timer first else this will return 0.

Returns: long

Since: 12-26-2024

top

String toString()

Returns a description of this object.

Returns: String

Since: 01-04-2010

top

API Date: Dec 30, 2024 11:45 AM