wt.query
Class BasicPageableQuerySpec

java.lang.Object
  wt.query.PageableQuerySpec
      wt.query.BasicPageableQuerySpec

All Implemented Interfaces:

Externalizable, Serializable, StatementSpec, PageableSessionQuerySpec

public class BasicPageableQuerySpec
extends PageableQuerySpec
implements PageableSessionQuerySpec, Externalizable

This class provides a standard implementation for establishing a paging session. It also extends the PageableQuerySpec and can be used to retrieve an intial result page.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

Fields inherited from interface wt.query.PageableSessionQuerySpec

GROUP_FROM_INDEX, PAGE_THRESHOLD, PRIMARY_STATEMENT

Fields inherited from interface wt.pds.StatementSpec

ADVANCED_QUERY_ENABLED, USE_BIND

Method Summary

int	getGroupFromIndex() Gets the value of the attribute: groupFromIndex; Specifies a FromIndex from the snapshor query that will be used to group results for paging.
int	getPageThreshold() Gets the value of the attribute: pageThreshold; Specifies threshold at which a paging session will be established.
StatementSpec	getPrimaryStatement() Gets the object for the association that plays role: primaryStatement.
void	setGroupFromIndex(int a_GroupFromIndex) Sets the value of the attribute: groupFromIndex; Specifies a FromIndex from the snapshor query that will be used to group results for paging.
void	setPageThreshold(int a_PageThreshold) Sets the value of the attribute: pageThreshold; Specifies threshold at which a paging session will be established.
void	setPrimaryStatement(StatementSpec a_PrimaryStatement) Sets the object for the association that plays role: primaryStatement.

Methods inherited from class wt.query.PageableQuerySpec

getOffset, getRange, isAdvancedQueryEnabled, isUseBind, setAdvancedQueryEnabled, setLocale, setOffset, setRange, setUseBind

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.pds.StatementSpec

isAdvancedQueryEnabled, isUseBind, setAdvancedQueryEnabled, setLocale, setUseBind

Method Detail

getGroupFromIndex

public int getGroupFromIndex()

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

Supported API: true

Specified by:

getGroupFromIndex in interface PageableSessionQuerySpec

Returns:

int

setGroupFromIndex

public void setGroupFromIndex(int a_GroupFromIndex)
                       throws WTPropertyVetoException

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

Supported API: true

Specified by:

setGroupFromIndex in interface PageableSessionQuerySpec

Parameters:

a_GroupFromIndex -

Throws:

WTPropertyVetoException

getPageThreshold

public int getPageThreshold()

Gets the value of the attribute: pageThreshold; 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

Specified by:

getPageThreshold in interface PageableSessionQuerySpec

Returns:

int

setPageThreshold

public void setPageThreshold(int a_PageThreshold)
                      throws WTPropertyVetoException

Sets the value of the attribute: pageThreshold; 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

Specified by:

setPageThreshold in interface PageableSessionQuerySpec

Parameters:

a_PageThreshold -

Throws:

WTPropertyVetoException

getPrimaryStatement

public StatementSpec getPrimaryStatement()

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

Supported API: true

Specified by:

getPrimaryStatement in interface PageableSessionQuerySpec

Returns:

StatementSpec

setPrimaryStatement

public void setPrimaryStatement(StatementSpec a_PrimaryStatement)
                         throws WTPropertyVetoException

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

Supported API: true

Specified by:

setPrimaryStatement in interface PageableSessionQuerySpec

Parameters:

a_PrimaryStatement -

Throws:

WTPropertyVetoException