使用可能な検索キーの取得

AvailableSearchKeysConfig複合タイプによって、データ・ドメイン内で使用できる検索可能属性および検索インタフェースのリストを取得できます。

AvailableSearchKeysConfigタイプは、検索可能な、つまり検索インタフェースおよび検索可能プロパティである項目を識別します。このタイプの書式は、次のとおりです。 
<AvailableSearchKeysConfig Id="?">
   <StateName>?</StateName>
</AvailableSearchKeysConfig>
変数の意味は次のとおりです。
  • Idは、この構成の任意の識別子を提供するオプション属性です。
  • StateNameは、リクエストで状態の名前を指定するオプション属性です。(複数の状態があるリクエストにおいても)状態を指定しても結果に影響しないことに注意してください。

使用可能な検索キーのサンプル・リクエスト

次の例では、AvailableSearchKeysConfigタイプを使用して使用可能な検索キーのリクエストを作成する方法を示しています。 
<Request xmlns="http://www.endeca.com/MDEX/conversation/3/0">
   <State/>
   <AvailableSearchKeysConfig Id="MySearchKeys"/>
</Request>

状態が空の、名前のない状態であるため、StateName要素が使用されていないことに注意してください。

使用可能な検索キーのレスポンス

レスポンスには、次の例に示すように、単一のアルファベット順のリストにすべての検索可能キーがリストされているAvailableSearchKeysコンポーネントが含まれています。 
<cs:Results xmlns:cs="http://www.endeca.com/MDEX/conversation/3/0" 
     xmlns:mdex="http://www.endeca.com/MDEX/XQuery/2009/09">
   <State xmlns="http://www.endeca.com/MDEX/conversation/3/0" x
       mlns:ns2="http://www.endeca.com/MDEX/eql_parser/types" 
       xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"/>
   <cs:AvailableSearchKeys> 
      <cs:AvailableSearchKey Interface="true">
         <cs:Key>AllWineSearch</cs:Key>
         <cs:DisplayName>AllWineSearch</cs:DisplayName>
      </cs:AvailableSearchKey>
      <cs:AvailableSearchKey Interface="false">
         <cs:Key>Description</cs:Key>
         <cs:DisplayName>Wine Description</cs:DisplayName>
      </cs:AvailableSearchKey>
      <cs:AvailableSearchKey Interface="false">
         <cs:Key>WineType</cs:Key>
         <cs:DisplayName>Wine Type</cs:DisplayName>
      </cs:AvailableSearchKey>
   </cs:AvailableSearchKeys>
</cs:Results>

各AvailableSearchKey要素は、検索可能属性または検索インタフェース(Keyサブ要素)の名前、およびNCName以外の書式を持つことができる表示名をリストします。Interface属性は、検索キーが検索可能属性と検索インタフェースのどちらであるかを識別します。検索キーが検索インタフェースである場合、属性はtrueに設定されます。検索キーが検索インタフェースではなく、検索可能属性である場合、属性はfalseに設定されます。

このサンプル・レスポンスでは、1つの検索インタフェースAllWineSearch、および2つの属性DescriptionとWineTypeが、使用可能な検索キーとしてリストされます。