Package wt.query

Class PagingSessionSpec

java.lang.Object

wt.query.PageableQuerySpec

wt.query.PagingSessionSpec

All Implemented Interfaces:

Externalizable, Serializable, StatementSpec

public final class PagingSessionSpec
extends PageableQuerySpec
implements Externalizable

This class can be used to fetch pages from an established paging session.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Field Summary

Fields inherited from interface wt.pds.StatementSpec

ADVANCED_QUERY, ADVANCED_QUERY_ENABLED, AGGREGATE_SELECT, CORRELATED_CLASS_ATTRIBUTES, FETCH_SIZE, PRIMARY_CLASS, QUERY_LIMIT, QUERY_LIMIT_DISABLED, RESULT_BUILDER, RESULT_CURSOR, SINGLE_RESULT_COMPATIBLE, STATEMENT_BUILDER, USE_BIND

Constructor Summary

Constructors

Constructor	Description
PagingSessionSpec(long a_sessionId)	Supported API: true Conditional Support: This is supported for sessionId of PagingQueryResult sessionId.

Method Summary

Modifier and Type	Method	Description
long	getSessionId()	Gets the value of the attribute: sessionId; Identifies a persistent paging session.
int	getTotalSize()	Gets the value of the attribute: totalSize; Specifies the total number of results that can be paged through.

Methods inherited from class wt.query.PageableQuerySpec

getBindParameterCount, getCorrelatedClassAttributes, getFetchSize, getOffset, getPrimaryClass, getPrimaryStatement, getQueryLimit, getRange, getResultBuilder, getResultCursor, getStatementBuilder, isAdvancedQuery, isAdvancedQueryEnabled, isAggregateSelect, isConcurrentEnabled, isSingleResultCompatible, isUseBind, readVersion, setAdvancedQueryEnabled, setBindParameterAt, setConcurrentEnabled, setFetchSize, setLocale, setOffset, setPrimaryStatement, setRange, setUseBind

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.pds.StatementSpec

getIsFaultToleranceSession, setIsFaultToleranceSession

Constructor Details

PagingSessionSpec

public PagingSessionSpec(long a_sessionId)

Supported API: true

Conditional Support: This is supported for sessionId of PagingQueryResult sessionId.

Example:

           // queryResult is nothing but PagingQueryResult
           long sessionId = queryResult.getSessionId();
   

Parameters:

a_sessionId - Identifier a persistent paging session

Method Details

getTotalSize

public int getTotalSize()

Gets the value of the attribute: totalSize; Specifies the total number of results that can be paged through.

Supported API: true

Returns:

int

getSessionId

public long getSessionId()

Gets the value of the attribute: sessionId; Identifies a persistent paging session.

Supported API: true

Returns:

long