レコード・リストの構成

RecordListConfig複合タイプを使用して、問合せから返されるレコードのリストの設定を構成します。

RecordListConfigでは、たとえば、リストのページ当たりに含まれるレコード数、返す必要のあるレコードのページ数、リストに含まれるレコードごとに返す必要のある属性、およびレコード・リストのソート基準にする属性を構成できます。RecordListConfigを含む問合せの結果として、RecordListが返されます。

RecordListConfig複合タイプで、レコード・リストで返す必要のある情報を定義します。RecordListConfigタイプの書式を次の省略された例に示します。
<Request>
  <ContentElementConfig xsi:type="ns:RecordListConfig"
    Id="RecordList"
    HandlerFunction="RecordListHandler"
    HandlerNamespace="http://www.endeca.com/MDEX/conversation/2/0" 
    MaxPages="2">
      <Column>ModelName</Column>
      <Column>Size</Column>
      <RecordsPerPage>10</RecordsPerPage>
      <Page>1</Page>
      <Sort Key="ModelName" Direction="Ascending"/>
  </ContentElementConfig>
</Request>
RecordListConfig複合タイプで指定される要素と属性は次のとおりです。
要素/属性 説明
HandlerFunction このContentElementConfigRecordListHandlerハンドラ関数を指定します。必須です。
HandlerNamespace ハンドラ関数のネームスペースを指定します。必須です。
Id このContentElementConfigの任意の識別子。必須です。
MaxPages オプションで、返すレコード・ページの最大数を整数で指定します。この属性が省略されている場合、デフォルト値の20が問合せに使用されます。
Column オプションで、RecordListでレコードとともに返される属性を定義します。Column要素の複数のインスタンスを指定できます。主キーは自動的に返されるため、指定する必要はありません。Column要素が指定されていない場合は、すべてのレコードの標準属性と管理属性が返されます。
RecordsPerPage オプションで、結果のContentElementに表示する最大レコード数(Record要素)を整数で指定します。この要素が省略されている場合は、デフォルト値の10が使用されます。
Page オプションで、表示するページを整数で指定します(つまり、ページのリスト全体に対するオフセットを指定します)。オフセットはゼロベースの索引であり、0 (ゼロ)は最初のページを意味します。この要素により、ユーザーは長い結果セットのページを直接またはステップ単位で指定できます。オフセットがページの総数より大きい場合、返されるレコード・リストにはレコードが含まれません。この要素が省略されている場合は、デフォルト値の0が使用されます。
Sort Key Direction オプションで、レコード・リストのソート順序を指定します。Keyは、ソートに使用する標準属性または管理属性を指定します。Directionは、Ascending (デフォルト)またはDescendingのソート順序を指定します。