atg.search.routing.command.search
Interface PagedResponse

All Known Implementing Classes:

BrowseRequest.Response, QueryRequest.Response, SearchResultsResponse, SimilarDocsRequest.Response, StructuredQueryRequest.Response, TreeQueryRequest.Response

public interface PagedResponse

Interface for responses from PagedRequests.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

int	getGroupCount() total number of answer groups before paging.
boolean	getHasMoreResults() Returns true if there are more results.
int	getPageNum() Returns the zero-based page number of this response
atg.search.routing.command.search.PageOffsetInfo	getPageOffsetInfo() If the response is the result of a merge, this holds the last response index per partition
int	getPageSize() Returns the page size
void	setPageNum(int pPageNum) Sets the zero-based page number of this response
void	setPageOffsetInfo(atg.search.routing.command.search.PageOffsetInfo pageOffsetInfo) Sets the page offset info
void	setPageSize(int pPageSize) Sets the page size

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getPageOffsetInfo

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

If the response is the result of a merge, this holds the last response index per partition

Returns:

If the response is the result of a merge, this holds the last response index per partition

setPageOffsetInfo

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

Sets the page offset info

Parameters:

pageOffsetInfo - page offset information

getPageNum

int getPageNum()

Returns the zero-based page number of this response

Returns:

zero-based page number of this response

setPageNum

void setPageNum(int pPageNum)

Sets the zero-based page number of this response

Parameters:

pPageNum -

getPageSize

int getPageSize()

Returns the page size

Returns:

results per page

setPageSize

void setPageSize(int pPageSize)

Sets the page size

Parameters:

pPageSize -

getGroupCount

int getGroupCount()

total number of answer groups before paging. For response types that do not use answer groups, this is the total number of results.

Returns:

total number of answer groups before paging

getHasMoreResults

boolean getHasMoreResults()

Returns true if there are more results. Returns false if all results have already been retrieved

Returns:

true if there are more results. Returns false if all results have already been retrieved