atg.search.routing.command.search
Interface PagedRequest

All Known Implementing Classes:

BrowseRequest, QueryRequest, SimilarDocsRequest, StructuredQueryRequest, TreeQueryRequest

public interface PagedRequest

Implemented by pageable request types.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	ORIG_PAGE_SIZE
static java.lang.String	PAGE_NUM
static java.lang.String	PAGE_OFFSET_INFO
static java.lang.String	PAGE_SIZE

Method Summary

java.lang.Boolean	getFastPaging() Returns an indication of whether fast paging is enabled for this request.
java.lang.Integer	getPageNum() Returns the 0-based page number that should be retrieved.
atg.search.routing.command.search.PageOffsetInfo	getPageOffsetInfo() Returns internal page offset information when fast paging is used with a multi-partition index.
java.lang.Integer	getPageSize() Returns the number of results that should be returned per page
void	setFastPaging(java.lang.Boolean pFastPaging) Sets whether fast paging is enabled for this request.
void	setPageNum(java.lang.Integer pageNum) Sets the 0-based page number that should be retrieved.
void	setPageOffsetInfo(atg.search.routing.command.search.PageOffsetInfo pPageOffsetInfo) Sets the page offset information, which is used internally to manage fast paging for multiple partitions.
void	setPageSize(java.lang.Integer pageSize) Sets the number of results that should be returned per page.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

PAGE_OFFSET_INFO

static final java.lang.String PAGE_OFFSET_INFO

See Also:

Constant Field Values

PAGE_NUM

static final java.lang.String PAGE_NUM

See Also:

Constant Field Values

PAGE_SIZE

static final java.lang.String PAGE_SIZE

See Also:

Constant Field Values

ORIG_PAGE_SIZE

static final java.lang.String ORIG_PAGE_SIZE

See Also:

Constant Field Values

Method Detail

getFastPaging

java.lang.Boolean getFastPaging()

Returns an indication of whether fast paging is enabled for this request. Fast paging is only relevant for multi-partition requests. Fast paging never returns more than is required for a given page. The trade-off is that for large multi-partition indexes you lose jump-to-page functionality. It is disabled by default

Returns:

true if fast paging is enabled for this request, false by default

setFastPaging

void setFastPaging(java.lang.Boolean pFastPaging)

Sets whether fast paging is enabled for this request. Fast paging is only relevant for multi-partition requests. Fast paging never returns more than is required for a given page. The trade-off is that for large multi-partition indexes you lose jump-to-page functionality. It is disabled by default

Parameters:

pFastPaging - true to enable fast paging

getPageSize

java.lang.Integer getPageSize()

Returns the number of results that should be returned per page

Returns:

number of results that should be returned per page

setPageSize

void setPageSize(java.lang.Integer pageSize)

Sets the number of results that should be returned per page. For efficiency, most search sites return results a page at a time, forcing the end-user to request additional results if necessary.

Parameters:

pageSize - number of results that should be returned per page

getPageNum

java.lang.Integer getPageNum()

Returns the 0-based page number that should be retrieved.

Returns:

the 0-based page number that should be retrieved, starting from the first page 0 and so on.

setPageNum

void setPageNum(java.lang.Integer pageNum)

Sets the 0-based page number that should be retrieved.

Parameters:

pageNum - specifies which 0-based page number to return, starting from the first page 0 and so on.

setPageOffsetInfo

void setPageOffsetInfo(atg.search.routing.command.search.PageOffsetInfo pPageOffsetInfo)

Sets the page offset information, which is used internally to manage fast paging for multiple partitions. Not normally used.

Parameters:

pPageOffsetInfo - page offset info

getPageOffsetInfo

atg.search.routing.command.search.PageOffsetInfo getPageOffsetInfo()

Returns internal page offset information when fast paging is used with a multi-partition index.

Returns:

internal page offset information when fast paging is used with a multi-partition index.