SearchRequestBase is the base class for search requests (SearchQuery and SearchMatch) with parameters for paging and sorting.
Paging Support
The parameters for the paging mechanism to return large result sets are as follows:
Maximum number of records returned
—This parameter can be specified at the ORS level and it is stored in the CMX_SYSTEM.C_REPOS_DATABASE.GETLIST_LIMIT parameter. This limit takes precedence over the values specified using setRecordsToReturn(int). The search queries will be limited to the minimum value of the two for any search request. For SearchMatchRequest API, there are also additional parameters that can be specified on the Process Server to control the number of matches the Hub will attempt before returning the results.
Number of records
—setRecordsToReturn(int). When paging is enabled this parameter specifies the size of the first page of data returned by the search API. Subsequent pages can be returned using the GetSearchResultsRequest API. Alternatively, for requests that have paging disabled this method would specify the limit of the total number of rows returned by the search API.
The paging mechanism is enabled by default
— disable paging by using the setDisablePaging() methods of APIs such as SearchQuery and SearchMatch that support paging. If the setDisablePaging() method is set to
false
, then a search token is returned. The search token is used by GetSearchResults to return additional results.
The search token is deleted
—After a period of inactivity longer than the
sif.search.result.query.timeToLive.seconds
setting specified in the Hub Server properties. GetSearchResults calls made after the token is expired would result in an error.
For more information, refer to the SIF API Javadocs.