プロファイル・リポジトリーの検索基準と一致するエントリーを見つけるためには、search メソッドを使用します。
目的
search SPI は、プロファイル・リポジトリーを検索して、
検索式と一致するエンティティーを取得します。
検索によって返されたプロパティーのリストは、
入力データ・グラフの SearchControl に組み込まれます。PageControl または SortControl、あるいはその両方を入力データ・
グラフに組み込むこともできます。入力データ・グラフの SearchControl には、検索式ストリングが含まれます。リポジトリー API の
実装クラスは、XPath ベースの検索式ストリングを解析する必要があります。
注:
このメソッドは、ページング機能が使用されない場合には、検索式と一致するすべてのエンティティーが組み込まれたデータ・グラフを
返します。ページング機能の場合には、出力データ・グラフに PageResponseControl も組み込む必要があります。
エンティティーの数がページ・サイズより大きい場合には、以降の呼び出しで使用できるように、PageResponseControl から cookie も
返す必要があります。ページング検索の以降の呼び出しでページ・サイズが 0 に設定されている場合には、呼び出し元が残りの
検索結果を必要としていないことを意味します。アダプターは、必要な場合に、キャッシュのパージなどのデータのクリーンアップを
実行することができます。
注: Virtual member manager は、
基礎になっているデータ・ストアのページング機能を使用しません。
返されるエンティティーの uniqueName は
Virtual member manager の uniqueName であり、これは必ずしもデータ・ストアの固有名と同じではありません。
アダプターは、そのアダプターの構成情報に従って、データ・ストアの固有名を Virtual member manager の
uniqueName に転送します。
パラメーター
- root
- 検索に関連した
コントロールが入っているルート・データ・オブジェクトを指定します。
戻されるもの
検索式と一致したエンティティーが入っているルート・データ・オブジェクト。
シグニチャー
DataObject search(DataObject root) は
WIMException をスローします