wt.fc
Class PagingQueryResult

java.lang.Object
  wt.fc.QueryResult
      wt.fc.PagingQueryResult

All Implemented Interfaces:

Enumeration, Externalizable, Serializable

public class PagingQueryResult

extends QueryResult

implements Externalizable

This class is a container of results returned from a query along with paging session information.

Supported API: true

Extendable: false

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class wt.fc.QueryResult

QueryResult.ChunkedExternalization, QueryResult.DuplicateStringEliminator

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private Object	fetchInfo
private int	groupSize
protected static long	OLD_FORMAT_VERSION_UID
private PagingSession	pagingSession
private PagingSessionSpec	pagingSpec
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.QueryResult

Constructor Summary

PagingQueryResult()


Supported API: false

PagingQueryResult(PagingSession a_pagingSession, PagingSessionSpec a_pagingSpec)


Supported API: false

PagingQueryResult(PagingSession a_pagingSession, PagingSessionSpec a_pagingSpec, Object a_fetchInfo)


Supported API: false

Method Summary

Object	getFetchInfo() Gets the value of the attribute: fetchInfo.
int	getGroupSize() Gets the value of the attribute: groupSize.
PagingSession	getPagingSession() Gets the value of the attribute: pagingSession; PagingSession instance that has been established for the query.
PagingSessionSpec	getPagingSpec() Gets the value of the attribute: pagingSpec; Paging specification object used to fetch subsequent pages.
long	getSessionId() Gets the value of the attribute: sessionId; Identifies the persistent paging session.
int	getTotalSize() Gets the value of the attribute: totalSize; Total number of results that can be paged through.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(PagingQueryResult thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setGroupSize(int a_GroupSize) Sets the value of the attribute: groupSize.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class wt.fc.QueryResult

append, appendObjectVector, getEnumeration, getObjectVector, getObjectVectorIfc, hasMoreElements, nextElement, readVersion, reset, size

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

pagingSession

private PagingSession pagingSession

pagingSpec

private PagingSessionSpec pagingSpec

groupSize

private int groupSize

fetchInfo

private Object fetchInfo

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

PagingQueryResult

public PagingQueryResult()

Supported API: false

PagingQueryResult

public PagingQueryResult(PagingSession a_pagingSession,
                         PagingSessionSpec a_pagingSpec)

Supported API: false

Parameters:

a_pagingSession - Paging session instance that has been established.

a_pagingSpec - Paging specification object used to fetch subsequent pages.

PagingQueryResult

public PagingQueryResult(PagingSession a_pagingSession,
                         PagingSessionSpec a_pagingSpec,
                         Object a_fetchInfo)

Supported API: false

Parameters:

a_pagingSession - Paging session instance that has been established.

a_pagingSpec - Paging specification object used to fetch subsequent pages.

a_fetchInfo -

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class QueryResult

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class QueryResult

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(PagingQueryResult thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

getPagingSession

public PagingSession getPagingSession()

Gets the value of the attribute: pagingSession; PagingSession instance that has been established for the query.

Supported API: false

Returns:

PagingSession

getPagingSpec

public PagingSessionSpec getPagingSpec()

Gets the value of the attribute: pagingSpec; Paging specification object used to fetch subsequent pages.

Supported API: true

Returns:

PagingSessionSpec

getTotalSize

public int getTotalSize()

Gets the value of the attribute: totalSize; 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 the persistent paging session.

Supported API: true

Returns:

long

getGroupSize

public int getGroupSize()

Gets the value of the attribute: groupSize.

Supported API: false

Returns:

int

setGroupSize

public void setGroupSize(int a_GroupSize)
                  throws WTPropertyVetoException

Sets the value of the attribute: groupSize.

Supported API: false

Parameters:

a_GroupSize -

Throws:

WTPropertyVetoException

getFetchInfo

public Object getFetchInfo()

Gets the value of the attribute: fetchInfo.

Supported API: false

Returns:

Object