Paging through a large record set

If many records are returned, you can use the Page attribute to specify the page to be displayed.

A query to the Oracle Endeca Server may return more records than can be displayed all at once. A common user interface mechanism for overcoming this is to create pages of results, where each page displays a subset of the entire result set.

The RecordList in the Results response includes these page-relevant fields:

NumRecords specifies the total number of records that were returned from the query.
TotalPages lists the total number of pages of records.
RecordRange lists the starting and ending records for this page set.

The following is an abbreviated example of these fields - a RecordList with a total of seven record pages and three records per page:

<RecordList Id="RecordList">
   <NumRecords>2231</NumRecords>
   <TotalPages>224</TotalPages>
   <RecordRange First="1" Last="10"/>
   ...
</cs:RecordList>

The RecordList is the initial access point for providing the paging controls for the entire record set. By default, the query returns a maximum of ten records for display. To override this setting, use the RecordsPerPage element in the RecordListConfig type, as in this example that sets five records per page for display:

<RecordListConfig Id="RecordList" MaxPages="20">
   <RecordsPerPage>5</RecordsPerPage>
   ...
</RecordListConfig>

The default page offset for a record set is zero, meaning that the first ten records are displayed. The default offset can be overridden with the Page attribute, as in this example that sets the offset to the third page of records:

<RecordListConfig Id="RecordList" MaxPages="20">
   ...
   <Page>3</Page>
</RecordListConfig>

If the number of total pages is 1:

<TotalPages>1</TotalPages>

then no paging controls are needed.