wt.query
Interface PageableSessionQuerySpec

All Superinterfaces:

StatementSpec

All Known Implementing Classes:

BasicPageableQuerySpec

public interface PageableSessionQuerySpec
extends StatementSpec

This interface specifies the abstractions necessary to establish a persistent paging session.

Supported API: true

Extendable: false

Field Summary

static String	GROUP_FROM_INDEX Label for the attribute; Specifies a FromIndex from the snapshor query that will be used to group results for paging.
static String	PAGE_THRESHOLD Label for the attribute; Specifies threshold at which a paging session will be established.
static String	PRIMARY_STATEMENT Label for the attribute.

Fields inherited from interface wt.pds.StatementSpec

ADVANCED_QUERY_ENABLED, USE_BIND

Method Summary

int	getGroupFromIndex() Gets the value of the attribute: GROUP_FROM_INDEX.
int	getPageThreshold() Gets the value of the attribute: PAGE_THRESHOLD.
StatementSpec	getPrimaryStatement() Gets the object for the association that plays role: PRIMARY_STATEMENT.
void	setGroupFromIndex(int a_GroupFromIndex) Sets the value of the attribute: GROUP_FROM_INDEX.
void	setPageThreshold(int a_PageThreshold) Sets the value of the attribute: PAGE_THRESHOLD.
void	setPrimaryStatement(StatementSpec a_PrimaryStatement) Sets the object for the association that plays role: PRIMARY_STATEMENT.

Methods inherited from interface wt.pds.StatementSpec

isAdvancedQueryEnabled, isUseBind, setAdvancedQueryEnabled, setLocale, setUseBind

Field Detail

GROUP_FROM_INDEX

static final String GROUP_FROM_INDEX

Label for the attribute; Specifies a FromIndex from the snapshor query that will be used to group results for paging.

Supported API: true

See Also:

Constant Field Values

PAGE_THRESHOLD

static final String PAGE_THRESHOLD

Label for the attribute; Specifies threshold at which a paging session will be established. If the snapshot query contains fewer items than this threshold, then those items will be returned and no paging session will be established. The default value for this attribute is obtained from the system property "wt.pom.paging.threshold".

Supported API: true

See Also:

Constant Field Values

PRIMARY_STATEMENT

static final String PRIMARY_STATEMENT

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getGroupFromIndex

int getGroupFromIndex()

Gets the value of the attribute: GROUP_FROM_INDEX. Specifies a FromIndex from the snapshor query that will be used to group results for paging.

Supported API: true

Returns:

int

setGroupFromIndex

void setGroupFromIndex(int a_GroupFromIndex)
                       throws WTPropertyVetoException

Sets the value of the attribute: GROUP_FROM_INDEX. Specifies a FromIndex from the snapshor query that will be used to group results for paging.

Supported API: true

Parameters:

a_GroupFromIndex -

Throws:

WTPropertyVetoException

getPageThreshold

int getPageThreshold()

Gets the value of the attribute: PAGE_THRESHOLD. Specifies threshold at which a paging session will be established. If the snapshot query contains fewer items than this threshold, then those items will be returned and no paging session will be established. The default value for this attribute is obtained from the system property "wt.pom.paging.threshold".

Supported API: true

Returns:

int

setPageThreshold

void setPageThreshold(int a_PageThreshold)
                      throws WTPropertyVetoException

Sets the value of the attribute: PAGE_THRESHOLD. Specifies threshold at which a paging session will be established. If the snapshot query contains fewer items than this threshold, then those items will be returned and no paging session will be established. The default value for this attribute is obtained from the system property "wt.pom.paging.threshold".

Supported API: true

Parameters:

a_PageThreshold -

Throws:

WTPropertyVetoException

getPrimaryStatement

StatementSpec getPrimaryStatement()

Gets the object for the association that plays role: PRIMARY_STATEMENT.

Supported API: true

Returns:

StatementSpec

setPrimaryStatement

void setPrimaryStatement(StatementSpec a_PrimaryStatement)
                         throws WTPropertyVetoException

Sets the object for the association that plays role: PRIMARY_STATEMENT.

Supported API: true

Parameters:

a_PrimaryStatement -

Throws:

WTPropertyVetoException