Package com.oorian

Class AjaxPollInterval

java.lang.Object

com.oorian.AjaxPollInterval

public final class AjaxPollInterval
extends Object

Represents an AJAX poll interval value used in CommunicationMode.AJAX_ONLY mode.

When using AJAX_ONLY communication mode, the client can optionally poll the server at regular intervals to retrieve pending updates. This class provides named constants for special poll interval values and can hold custom interval values.

Usage:

 // Use application-wide default poll interval
 page.setPollInterval(AjaxPollInterval.APP_DEFAULT);

 // Disable polling (updates only on user-triggered events)
 page.setPollInterval(AjaxPollInterval.DISABLED);

 // Custom poll interval in milliseconds
 page.setPollInterval(5000);
 

Field Summary

Fields

Modifier and Type	Field	Description
static final long	APP_DEFAULT	Use the application-wide default poll interval set via Application.setDefaultPollInterval(long).
static final long	DISABLED	Disable polling.

Constructor Summary

Constructors

Constructor	Description
AjaxPollInterval()	Creates an AjaxPollInterval with a default value of DISABLED.
AjaxPollInterval(long value)	Creates an AjaxPollInterval with the specified value.

Method Summary

Modifier and Type	Method	Description
long	getValue()	Gets the poll interval value.
AjaxPollInterval	setValue(long value)	Sets the poll interval value.

Methods inherited from class java.lang.Object

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

Field Details

APP_DEFAULT

public static final long APP_DEFAULT

Use the application-wide default poll interval set via Application.setDefaultPollInterval(long).

See Also:

• Constant Field Values

DISABLED

public static final long DISABLED

Disable polling. Updates will only be retrieved in response to user-triggered events.

See Also:

• Constant Field Values

Constructor Details

AjaxPollInterval

public AjaxPollInterval()

Creates an AjaxPollInterval with a default value of DISABLED.

AjaxPollInterval

public AjaxPollInterval(long value)

Creates an AjaxPollInterval with the specified value.

Parameters:

value - The poll interval in milliseconds (-1 = app default, 0 = disabled, >0 = interval).

Method Details

setValue

public AjaxPollInterval setValue(long value)

Sets the poll interval value.

Parameters:

value - The poll interval in milliseconds.

Returns:

This AjaxPollInterval instance for method chaining.

getValue

public long getValue()

Gets the poll interval value.

Returns:

The poll interval in milliseconds (-1 = app default, 0 = disabled, >0 = interval).