RefinementGroupConfig

RefinementGroupConfig要素は、属性グループに含まれる属性から絞込みのリストを返します。

対話Webサービス・リクエストのRefinementGroupConfig要素とRefinementConfig要素を使用して、属性の絞込み値を公開します。これらの要素により、多くの属性をすべて列挙しなくても、それらの属性に対する操作を一度に実行できます。

デフォルトでは、グループと絞込みの属性は折りたたまれています。絞込みを持つ属性を公開する場合は、絞込みを公開する各属性でRefinementConfigを使用するか、ExposeAllPropertyRefinementsを使用して、一度にすべての属性の絞込みを公開します。

RefinementGroupConfig要素にはRefinementConfig要素が含まれます。RefinementGroupConfigの構文は次のとおりです。
<RefinementGroupConfig Name="?" Expose="?" ExposeAllPropertyRefinements="?">
   <RefinementConfig .../>
</RefinementGroupConfig>
RefinementGroupConfigには次のパラメータが含まれます。
属性 説明
Name 必須です。属性グループの名前。
Expose 必須です。グループの属性を、少しでも可能性のある絞込みとして評価するかどうかを示すブール値です。Expose属性の使用は、絞込みのグループがあり、フロントエンド・アプリケーションのユーザー・インタフェースでこれらの展開や折りたたみを行うことができるようにする場合は重要です。たとえば、国名の絞込みが必要な場合、それらを取得するには、UIで展開と折りたたみを有効にするExposeを初期リクエストで使用します。次に、個別の対話Webサービス・リクエストでこれらの絞込みをリクエストします。
ExposeAllPropertyRefinements オプションです。グループのすべての属性に対して絞込みを公開する(つまり、絞込み値を計算する)かどうかを示します。
RefinementConfig NavigationMenuConfigで個々の属性の動作を制御します。これは、ナビゲーション問合せで返される有効なすべての絞込みのうち、どの属性が実際の絞込み値を返す必要があるかを指定し、絞込み値の順序と数も指定します。また、提案される絞込みと適用済の絞込み(暗黙的なものを含む)の両方を含む、絞込みの完全なリストを返すかどうかの指定も含みます。
RefinementConfig要素は、次の例で示すようにNavigationMenuConfig要素で使用されます。2つのExpose属性が2つの異なるレベルの公開に使用されており、1つ目ではグループの属性が公開され、2つ目ではその属性下の絞込みが公開されます。つまり、このリクエストはグループの属性を公開してから、グループSales-Transactionの一部であるOrderQuantity属性の絞込み値を公開します。
<Request xmlns="http://www.endeca.com/MDEX/conversation/3/0">
   <State/>
   <NavigationMenuConfig Id="NavigationMenu">
     <RefinementGroupConfig Name="Sales-Transaction" Expose="true">
       <RefinementConfig Name="OrderQuantity" Expose="true" MaximumCount="100" /> 
     </RefinementGroupConfig> 
   </NavigationMenuConfig>
</Request>

グループの個々の属性に対して操作を実行する場合、そのすべてに対して実行するのではなく(たとえば、個々の属性の設定をオーバーライドするなど)、RefinementGroupConfigで複数のRefinementConfig要素を使用できます。