com.ptc.windchill.enterprise.search.server
Class SearchPagingHelper

java.lang.Object
  com.ptc.windchill.enterprise.search.server.SearchPagingHelper

All Implemented Interfaces:

Externalizable, Serializable

public final class SearchPagingHelper

extends Object

implements Externalizable

Set up SearchPagingInfo based on parameters passed on Webject.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	PAGING_SESSION_ID
private static String	PAGING_SESSION_SIZE
private static String	RESOURCE
(package private) static long	serialVersionUID

Constructor Summary

SearchPagingHelper()

Method Summary

static ResultContainer	getResultFromPagingSession(SearchInfo searchInfo) If a paging session id is present get results from the paging session.
static SearchPagingInfo	initializePagingParameters(Webject webject) Set up SearchPagingInfo based on parameters passed on Webject.
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(SearchPagingHelper thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
static void	setPagingSessionParameters(Group group, SearchInfo searchInfo) Add paging session size and id to output group.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

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

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

PAGING_SESSION_ID

private static final String PAGING_SESSION_ID

See Also:

Constant Field Values

PAGING_SESSION_SIZE

private static final String PAGING_SESSION_SIZE

See Also:

Constant Field Values

Constructor Detail

SearchPagingHelper

public SearchPagingHelper()

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

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

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(SearchPagingHelper 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

initializePagingParameters

public static SearchPagingInfo initializePagingParameters(Webject webject)
                                                   throws WTException

Set up SearchPagingInfo based on parameters passed on Webject.

Supported API: false

Parameters:

webject -

Returns:

SearchPagingInfo

Throws:

WTException

setPagingSessionParameters

public static void setPagingSessionParameters(Group group,
                                              SearchInfo searchInfo)

Add paging session size and id to output group.

Supported API: false

Parameters:

group -

searchInfo -

getResultFromPagingSession

public static ResultContainer getResultFromPagingSession(SearchInfo searchInfo)
                                                  throws WTException

If a paging session id is present get results from the paging session.

Supported API: false

Parameters:

searchInfo -

Returns:

ResultContainer

Throws:

WTException