レコード・リストの構成

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

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

RecordListConfig複合タイプで、レコード・リストで返す必要のある情報を定義します。RecordListConfigタイプの書式は次のとおりです。

<RecordListConfig Id="?" MaxPages="20">
   <StateName>?</StateName>
   <Column>?</Column>
   <RecordsPerPage>?</RecordsPerPage>
   <Page>?</Page>
   <Sort Key="?" Direction="?"/>
</RecordListConfig>

RecordListConfig複合タイプで指定される要素と属性は次のとおりです。

要素/属性	説明
`Id`	必須です。このRecordListConfigの任意の識別子。
`MaxPages`	オプションです。返すレコード・ページの最大数を整数で指定します。この属性が省略されている場合、デフォルト値の20が問合せに使用されます。
`StateName`	次のルールを使用して、リクエストで既存の名前付きの状態を指定します。リクエストに複数の名前付きの状態がある場合は、`StateName`要素で名前付きの状態を1つだけ参照する必要があります。リクエストに名前付きの状態が1つだけある場合は、`StateName`要素を使用してその名前付きの状態を参照するかどうかはオプションです(RecordListConfigのどのイベントでもその状態が使用されるため)。リクエストに名前のない状態がある場合は、`StateName`要素を使用できません。
`Column`	オプションです。RecordListでレコードとともに返される属性を指定します。`Column`要素の複数のインスタンスを指定できます。主キーは自動的に返されるため、指定する必要はありません。`Column`要素が指定されていない場合は、すべてのレコードの標準属性と管理属性が返されます。
`RecordsPerPage`	オプションです。結果のContentElementに表示する最大レコード数(`Record`要素)を整数で指定します。この要素が省略されている場合は、デフォルト値の10が使用されます。
`Page`	オプションです。表示するページを整数で指定します(つまり、ページのリスト全体に対するオフセットを指定します)。オフセットはゼロベースの索引であり、0 (ゼロ)は最初のページを意味します。この要素により、ユーザーは長い結果セットのページを直接またはステップ単位で指定できます。オフセットがページの総数より大きい場合、返されるレコード・リストにはレコードが含まれません。この要素が省略されている場合は、デフォルト値の0が使用されます。
`Sort Key Direction`	オプションです。レコード・リストのソート順序を指定します。`Key`は、ソートに使用する標準属性または管理属性を指定します。`Direction`は、`Ascending` (デフォルト)または`Descending`のソート順序を指定します。

RecordListConfigの例

次のsoapUIの例では、Flavors属性の割当てがpeachesであるレコードを検索します。

<soapenv:Envelope 
   xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
   xmlns:ns="http://www.endeca.com/MDEX/conversation/3/0" 
   xmlns:typ="http://www.endeca.com/MDEX/eql_parser/types">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:Request>
         <ns:Language>en</ns:Language>
         <ns:State>
            <ns:Name>MyRecSearch</ns:Name>
            <ns:TextSearchFilter Key="Flavors" Mode="AllPartial" EnableSnippeting="false" 
                Language="en">peach</ns:TextSearchFilter>
         </ns:State>
         <ns:RecordListConfig Id="RecordList" MaxPages="20">
            <ns:StateName>MyRecSearch</ns:StateName>
            <ns:Column>Flavors</ns:Column>
            <ns:RecordsPerPage>5</ns:RecordsPerPage>
            <ns:Page>1</ns:Page>
            <ns:Sort Key="Flavors" Direction="Ascending"/>
         </ns:RecordListConfig>
      </ns:Request>
   </soapenv:Body>
</soapenv:Envelope>

RecordListConfigタイプにより、返されるレコード・リストの表示方法を構成しています。