com.crystaldecisions.sdk.occa.infostore
Interface IPagingQuery

All Superinterfaces:

IPagingQueryBase

public interface IPagingQuery

extends IPagingQueryBase

This interface provides information about a paged result set.

The underlying implementation caches certain information to maintain the state of pages across page reloads. While it manages cache use, it must also optimize query efficiency and memory use. When you use this interface, ensure that you do the following:

• To create a range, add items to the end of a result set
  Example: At indexing, fill the first range {[1,2,3,4,5], [6,7,8,9,10]}, and then add items 11, 12 to create the new range, {[1,2,3,4,5], [6,7,8,9,10]}, {[11,12]} .

  Reindexing starts only when you call getPage() on the final page of the previous range (in this case page 2, [6,7,8,9,10]). For example, in this case, 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 the range at indexing is {[1,2,3,4,5], [6,7,8]} and then you add 9,10,11,12 to fill the exact number of ranges specified, you do not have to call getPage() to force reindexing. as normally expected.

• To invalidate an entire range, remove items from the range.
  Example: If at indexing there are two ranges {[1,2,3,4,5], [6,7,8,9,10]}, {[11,12]}, remove the 11 and 12 to obtain the range {[1,2,3,4,5], [6,7,8,9,10]}. Alternatively, remove items 1 through 10 to obtain the range {[11,12]}.

  Reindexing starts only when you call getPage() on the removed page of results, which will return an empty page (like any query returning zero results).

Method Summary

IInfoObjects	getPage() Gets the current page content as an IInfoObjects collection.
void	setParameters(java.lang.String tables, int propSet, SearchPattern pattern, SortType sortBy) Sets the parameters for a 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

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

Sets the parameters for a paging query.

Parameters:

tables - The String that specifies the table in the CMS for the query. Choose from CI_INFOOBJECTS, CI_SYSTEMOBJECTS and CI_APPOBJECTS to construct the query. Most queries will require CI_INFOOBJECTS and CI_SYSTEMOBJECTS.

propSet - The int that specifies the PropertySet that defines the set of objects that are returned from the repository.

pattern - The SearchPattern that specifies the search pattern for the query.

sortBy - The SortType that specifies the sort type for the query.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPage

public IInfoObjects getPage()
                     throws SDKException

Gets the current page content as an IInfoObjects collection.

Returns:

The IInfoObjects colletion in the current page.

Throws:

SDKException - This is thrown if the process is unsuccessful.