AncestorControl DataObject

AncestorControl は、エンティティーの祖先を要求するために使用します。

AncestorControl DataObject は HierarchyControl から拡張されます。 このデータ・オブジェクトは、エンティティーの祖先を要求するために、get API の入力データ・オブジェクトで使用されます。 AncestorControl を get 操作のデータ・オブジェクトに追加すると、Root DataObject の下にあるエンティティーの祖先が戻りデータ・オブジェクトで戻されます。

AncestorControl は SearchControl から拡張されるため、AncestorControl に検索プロパティーを指定して、検索条件を満たす祖先のみを戻すようにすることができます。 AncestorControl はまた、祖先について戻すレベルとプロパティーを指定するためにも使用できます。

AncestorControl DataObject のデータ・グラフ構造は、以下のものから構成されます。
プロパティー
検索条件を満たすエンティティーから戻す属性のリストです。 例えば、マーケティング部門に所属する個人の sn および givenName 属性を取得できます。
searchBases
検索を制限するために使用される検索ベースのリストです。検索は、このリストに指定されたベースに制限されます。
countLimit
検索操作で戻される検索結果の最大数を指定します。
timeLimit
検索の最長継続時間をミリ秒で指定します (プロファイル・リポジトリーが timeLimit をサポートしている場合)。
expression
XPath 形式の検索式です。
level
戻す祖先のレベルを指定します。 レベルのデフォルト値は 1 です。次の表を参照してください。
この表は、祖先のレベルとして有効な値を要約したものです。
表 1. AncestorControl level の値
AncestorControl level 説明
1 (デフォルト) 親のみを戻します。
任意の正整数 指定されたレベルの祖先を戻します。 例えば、2 を指定すると、2 つのレベル (親と祖父母) が戻されます。
0 Virtual member manager ノード以下のすべての祖先を戻します。

XML スキーマ定義

次に、AncestorControl DataObject の XML スキーマ定義を示します。
<xsd:complexType name="AncestorControl">
		<xsd:complexContent>
			<xsd:extension base="HierarchyControl">
			</xsd:extension>
		</xsd:complexContent>
	</xsd:complexType>

サンプル・データ・オブジェクト

次に、すべての祖先と、それらの祖先の uid、cn、o、および ou プロパティー (存在する場合) を戻す、AncestorControl DataObject のサンプルを示します。
<wim:controls xsi:type="wim:AncestorControl" level="0">
    <wim:properties>uid</wim:properties>
    <wim:properties>cn</wim:properties>
    <wim:properties>o</wim:properties>
    <wim:properties>ou</wim:properties>
 </wim:controls>


利用条件 | フィードバック