com.goldencode.p2j.extension

Interface FWDTimer

All Superinterfaces:

Enabled

All Known Subinterfaces:

HandleCommon

All Known Implementing Classes:

PSTimer

public interface FWDTimer
extends Enabled

Interface of the FWD TIMER Extension. An FWDTimer object can be scheduled to run repetitive tasks at fixed intervals. This is not fully compatible with ABL standard language, it is an extension to 4GL specific to FWD.

Method Summary

Modifier and Type	Method and Description
void	cease() Force the timer to cease firing events.
default character	comHandle() Undocumented attribute found by chance.
character	getCallback() Gets the legacy name of the callback procedure to be called at fixed interval when running in FWD extension mode (not as a COM).
integer	getInterval() Obtain the current interval between two consecutive events.
void	setCallback(character callback) Sets the legacy name of the callback procedure to be called at fixed interval when running in FWD extension mode (ignored when in COM mode).
void	setCallback(java.lang.String callback) Sets the legacy name of the callback procedure to be called at fixed interval when running in FWD extension mode (ignored when in COM mode).
void	setInterval(long interval) Sets the current interval between two consecutive events.
void	setInterval(NumberType interval) Sets the current interval between two consecutive events.
void	start() Starts the timer.

Methods inherited from interface com.goldencode.p2j.util.Enabled

isEnabled, setEnabled, setEnabled

Method Detail

getInterval

integer getInterval()

Obtain the current interval between two consecutive events.

Returns:

the current value of interval property.

setInterval

void setInterval(NumberType interval)

Sets the current interval between two consecutive events. If the timer is already enabled, it will be automatically armed and will fire after interval millis elapses. Setting it to 0, will stop the timer. Setting to a negative value will lead to an error message to be displayed.

Parameters:

interval - The new interval between two timer events, in milliseconds.

setInterval

void setInterval(long interval)

Sets the current interval between two consecutive events. If the timer is already enabled, it will be automatically armed and will fire after interval millis elapses. Setting it to 0, will stop the timer. Setting to a negative value will lead to an error message to be displayed.

Parameters:

interval - The new interval between two timer events, in milliseconds.

getCallback

character getCallback()

Gets the legacy name of the callback procedure to be called at fixed interval when running in FWD extension mode (not as a COM).

Returns:

the legacy name of the callback procedure.

setCallback

void setCallback(character callback)

Sets the legacy name of the callback procedure to be called at fixed interval when running in FWD extension mode (ignored when in COM mode). If set to unknown the timer will continue 'ticking' but since there is no known peer to call, nothing will happen. This property can be set while the timer is active, without resetting it.

Parameters:

callback - the new legacy name of the callback procedure.

setCallback

void setCallback(java.lang.String callback)

Sets the legacy name of the callback procedure to be called at fixed interval when running in FWD extension mode (ignored when in COM mode). If set to unknown the timer will continue 'ticking' but since there is no known peer to call, nothing will happen. This property can be set while the timer is active, without resetting it.

Parameters:

callback - the new legacy name of the callback procedure.

start

void start()

Starts the timer. It has the exact effect like setting the enabled property to true. Note that timer will not be activated unless the interval property was set to a strictly positive value.

cease

void cease()

Force the timer to cease firing events. It has the exact effect like setting the enabled property to false.

The name of the method was selected intentionally for the FWD extension since STOP would create some syntactic incompatibility with standard ABL attributes.

comHandle

default character comHandle()

Undocumented attribute found by chance. Might as well be either one of:
- an attribute of Control Frame COM Object (from ControlFrameComObject);
- an attribute of any COM-HANDLE (from comhandle);
- id "0" some kind of unknown value for comhandle-s.

Returns:

Always some kind of "0".