Understanding a RecordList result

The records returned from the query are contained in the RecordList element.

A list of records is returned with every query result received from the Oracle Endeca Server. The list of records is represented as a RecordList complex type that is returned in a Results response by the Conversation Web Service. Each record is returned in a Record element.

The following sample snippet shows a RecordList with one record, one pagination control, and one column:
<cs:ContentElement xsi:type="cs:RecordList" Id="RecordList" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<cs:NumRecords>61096</cs:NumRecords>
<cs:TotalPages>6110</cs:TotalPages>
 <cs:RecordRange First="11" Last="20"/>
 <cs:RecordListEntry>

<cs:Record>
  <ProductName type="mdex:string">Bike Wash - Dissolver</ProductName>
  <ProductSubcategoryName type="mdex:string">Cleaners</ProductSubcategoryName>
  <Description type="mdex:string">Washes off the toughest road grime; dissolves grease
   </Description>
	...
</cs:Record>
<cs:ComputedProperties/>
 ...
<cs:PaginationControl Label="First" Active="true">
 <cs:Operator OwnerId="RecordList" Page="0" xsi:type="cs:PageOperator"/>
 </cs:PaginationControl>
  ...
<cs:Column ColumnKey="ProductName" DisplayName="Product Name" SpecColumn="false">
<cs:SortControl Key="ProductName" Direction="Ascending" Active="false" xsi:type="cs:SortControl">
<cs:Operator OwnerId="RecordList" xsi:type="cs:SortOperator" Key="ProductName" Direction="Ascending"/>
</cs:SortControl>
<cs:SortControl Key="ProductName" Direction="Descending" Active="false" xsi:type="cs:SortControl">
<cs:Operator OwnerId="RecordList" xsi:type="cs:SortOperator" Key="ProductName" Direction="Descending"/>
</cs:SortControl>
</cs:Column>
 ...
</cs:ContentElement>
The elements in the RecordList contain the following information:
  • NumRecords specifies the total number of records (Record elements) 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.
  • DimensionHierarchy lists paths of managed attributes whose values have assignments in the requested record list. Also contains DimensionValueWithPath.
  • Each RecordListEntry contains a specific record in a Record element and a ComputedProperties element that has any computed attributes (such as geocode distance or snippets) for that record.
  • PaginationControl is a control (a PageOperator) for a specific record page.
  • SortControl identifies the sort order (Ascending or Descending) of the attributes.
In addition, the attributes on the Column element contain the following information for a specific standard or managed attribute on a record:
  • ColumnKey identifies the name (in an NCName format) of the attribute.
  • DisplayName specifies the name of the attribute in an easy-to-understand format. (Once you define display names, they appear in the front-end application.)
  • SpecColumn identifies whether the attribute is the primary key for the records. If set to true, identifies this property as the primary key attribute for the records.

    The SpecColumn allows you to select a record for viewing its record details.