com.crystaldecisions.sdk.occa.infostore
Interface IPagingQuery

All Superinterfaces:

IPagingQueryBase

Deprecated. Since 4.0. CMS now supports paged queries, use ICMSQuery instead.

@Deprecated
public interface IPagingQuery
extends IPagingQueryBase

IPagingQuery provides information about a paged result set.

The underlying implementation has to cache certain information to maintain paging state. So it has to balance stale cache concerns against query efficiency and memory use. Some of the situations to look out for:

• Add items to the end of a result set, so that there is a new range
  eg. at indexing, full first range {[1,2,3,4,5] , [6,7,8,9,10]}, then add items 11, 12, ...

  Reindexing will not happen until you call getPage() on the "old" last page of results (in this case page 2, [6,7,8,9,10]). If you are on page 2 and call getHasNextPage/Range, the paging query will return false, until you call getPage() again.

  This limitation only applies when the original results fill exactly N ranges. If at indexing {[1,2,3,4,5], [6,7,8]} and we added 9,10,11,12, all methods would behave as normally expected.

• Items removed so that an entire range is invalidated
  eg. at indexing, two ranges {[1,2,3,4,5], [6,7,8,9,10]}, {[11,12]}, then remove 11 and 12, or remove items 1 through 10

  Reindexing will not happen until you call getPage() on the removed page of results, and then you will get an empty page (as with any query returning zero results).

Method Summary

IInfoObjects	getPage() Deprecated. Get current page content
void	setParameters(java.lang.String tables, int propSet, SearchPattern pattern, SortType sortBy) Deprecated. Set Parameters for paging query

Methods inherited from interface com.crystaldecisions.sdk.occa.infostore.IPagingQueryBase

getCurrPageNumber, getItemsPerPage, getPagesPerRange, getRangeFirstPageNumber, getRangeLastPageNumber, hasNextPage, hasNextRange, hasPrevPage, hasPrevRange, moveToFirstPage, moveToLastPage, moveToNextPage, moveToNextRange, moveToPreviousPage, moveToPreviousRange, setCurrPageNumber, setItemsPerPage, setPagesPerRange

Method Detail

setParameters

void setParameters(java.lang.String tables,
                   int propSet,
                   SearchPattern pattern,
                   SortType sortBy)
                   throws SDKException

Deprecated.

Set Parameters for paging query

Parameters:

tables - The table in CMS for the query

pattern - The search pattern for the query

sortBy - The Sort Type for the query

Throws:

SDKException

getPage

IInfoObjects getPage()
                     throws SDKException

Deprecated.

Get current page content

Returns:

IInfoObjects The infoobjects colletion in current page

Throws:

SDKException