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

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

All Implemented Interfaces:

Externalizable, Serializable

public final class SearchPagingInfo

extends Object

implements Externalizable

Holds paging data for a search.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private int	offset
protected static long	OLD_FORMAT_VERSION_UID
private int	pageCount
private PageMode	pageMode
private BasicTypePagingSession	pagingSession
private long	pagingSessionId
private static String	RESOURCE
(package private) static long	serialVersionUID

Constructor Summary

SearchPagingInfo()

Method Summary

int	getOffset() Gets the value of the attribute: offset; Index of first object returned from a result set.
int	getPageCount() Gets the value of the attribute: pageCount; Objects per page.
PageMode	getPageMode() Gets the value of the attribute: pageMode.
BasicTypePagingSession	getPagingSession() Gets the value of the attribute: pagingSession; A paged results session.
long	getPagingSessionId() Gets the value of the attribute: pagingSessionId; Identifies an existing paging session.
int	getPagingSessionSize() Supported API: false
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(SearchPagingInfo thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setOffset(int a_Offset) Sets the value of the attribute: offset; Index of first object returned from a result set.
void	setPageCount(int a_PageCount) Sets the value of the attribute: pageCount; Objects per page.
void	setPageMode(PageMode a_PageMode) Sets the value of the attribute: pageMode.
void	setPagingSession(BasicTypePagingSession a_PagingSession) Sets the value of the attribute: pagingSession; A paged results session.
void	setPagingSessionId(long a_PagingSessionId) Sets the value of the attribute: pagingSessionId; Identifies an existing paging session.
String	toString() Return String representation of CurrentPagingSession Supported API: false
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, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

pagingSession

private BasicTypePagingSession pagingSession

pageCount

private int pageCount

pagingSessionId

private long pagingSessionId

offset

private int offset

pageMode

private PageMode pageMode

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

SearchPagingInfo

public SearchPagingInfo()

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(SearchPagingInfo 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 BasicTypePagingSession getPagingSession()

Gets the value of the attribute: pagingSession; A paged results session.

Supported API: false

Returns:

BasicTypePagingSession

setPagingSession

public void setPagingSession(BasicTypePagingSession a_PagingSession)
                      throws WTPropertyVetoException

Sets the value of the attribute: pagingSession; A paged results session.

Supported API: false

Parameters:

a_PagingSession -

Throws:

WTPropertyVetoException

getPageCount

public int getPageCount()

Gets the value of the attribute: pageCount; Objects per page.

Supported API: false

Returns:

int

setPageCount

public void setPageCount(int a_PageCount)
                  throws WTPropertyVetoException

Sets the value of the attribute: pageCount; Objects per page.

Supported API: false

Parameters:

a_PageCount -

Throws:

WTPropertyVetoException

getPagingSessionId

public long getPagingSessionId()

Gets the value of the attribute: pagingSessionId; Identifies an existing paging session.

Supported API: false

Returns:

long

setPagingSessionId

public void setPagingSessionId(long a_PagingSessionId)
                        throws WTPropertyVetoException

Sets the value of the attribute: pagingSessionId; Identifies an existing paging session.

Supported API: false

Parameters:

a_PagingSessionId -

Throws:

WTPropertyVetoException

getOffset

public int getOffset()

Gets the value of the attribute: offset; Index of first object returned from a result set. Optional.

Supported API: false

Returns:

int

setOffset

public void setOffset(int a_Offset)
               throws WTPropertyVetoException

Sets the value of the attribute: offset; Index of first object returned from a result set. Optional.

Supported API: false

Parameters:

a_Offset -

Throws:

WTPropertyVetoException

getPageMode

public PageMode getPageMode()

Gets the value of the attribute: pageMode.

Supported API: false

Returns:

PageMode

setPageMode

public void setPageMode(PageMode a_PageMode)
                 throws WTPropertyVetoException

Sets the value of the attribute: pageMode.

Supported API: false

Parameters:

a_PageMode -

Throws:

WTPropertyVetoException

getPagingSessionSize

public int getPagingSessionSize()

Supported API: false

Returns:

int

toString

public String toString()

Return String representation of CurrentPagingSession

Supported API: false

Returns:

String