Monitor

Method Summary
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	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.
String	toString() Returns a description of this object.

Method Detail

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 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

String toString()

Returns a description of this object.

Returns: String

Since: 01-04-2010

top

API Date: Nov 18, 2024 01:04 PM