DescendantControl DataObject

DescendantControl は、エンティティーの子孫を要求するために使用します。

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

DescendantControl は SearchControl から拡張されるため、DescendantControl に検索プロパティーを指定して、検索条件を満たす子孫のみを戻すようにすることができます。 例えば、値 entities[@xsi:type='PersonAccount'] を含むプロパティー expression を追加すれば、PersonAccount エンティティー・タイプの子孫のみを戻すことができます。 DescendantControl はまた、子孫に対して、戻すレベルとプロパティーを指定するためにも使用できます。

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

XML スキーマ定義

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

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

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


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