Configuring a record list

You use the RecordListConfig complex type to configure settings for lists of records returned by the Oracle Endeca Server. For example, you can configure how many records should be included per page in the list, how many pages of records should be returned, which attributes should be returned for each record included in the list, and the attribute by which to sort the record list.

As a result of a query containing RecordListConfig, a RecordList is returned.

In the RecordListConfig complex type, you define what information should be returned in the record list. The format of the RecordListConfig type is shown in this example:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ns="http://www.endeca.com/MDEX/conversation/1/0" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:typ="http://www.endeca.com/MDEX/lql_parser/types">
   <soapenv:Header/>
   <soapenv:Body>
<ns:Request>
      <ns:ContentElementConfig xsi:type="ns:RecordListConfig"
          Id="RecordList"
          HandlerFunction="RecordListHandler"
          HandlerNamespace="http://www.endeca.com/MDEX/conversation/1/0" 
          MaxPages="2">
         <ns:Column>ModelName</ns:Column>
         <ns:Column>Size</ns:Column>
        <ns:RecordsPerPage>10</ns:RecordsPerPage>
          <ns:Page>1</ns:Page>
        <ns:Sort Key="ModelName" Direction="Ascending"/> 
          </ns:ContentElementConfig>
</ns:Request>
   </soapenv:Body>
</soapenv:Envelope>
The elements and attributes that must be specified in the RecordListConfig complex type are the following:
Element/Attribute Description
HandlerFunction Specifies the RecordListHandler handler function for this ContentElementConfig. Required.
HandlerNamespace Specifies the namespace for the handler function. Required.
Id An arbitrary identifier for this ContentElementConfig. Required.
MaxPages Optionally specifies an integer that is the maximum number of record pages to be returned. If this attribute is omitted, a default value of 20 is used for the query.
Column Optionally defines an attribute that will be returned in the RecordList with the record. You can specify multiple instances of the Column element. Note that you do not have to specify the primary key, because it is automatically returned. If no Column elements are specified, then all the record's standard and managed attributes are returned.
RecordsPerPage Optionally specifies an integer that is the maximum number of records (Record elements) to be displayed in the ContentElement of the result. If this element is omitted, a default value of 10 is used.
Page Optionally specifies an integer that is the page to be displayed (that is, it provides an offset into the overall list of pages). The offset is a zero-based index, which means that 0 (zero) specifies the first page. This element allows users to page through a long result set, either directly or step by step. If an offset is greater than the total number of pages, then the record list returned will not include records. If this element is omitted, a default value of 0 is used.
Sort Key Direction Optionally specifies a sort order for the record list. Key specifies the standard or managed attribute used for the sort. Direction specifies an Ascending (the default) or Descending sort order.