HierarchyControl DataObject
HierarchyControl is an extension from the SearchControl data object.
HierarchyControl extends from SearchControl. It is an abstract control, which means it is not directly used in the data object. Instead, its descendants AncestorControl, DescendantControl, GroupMemberControl and GroupMembershipControl are used
The structure of a HierarchyControl data object consists of:
- properties
- is a list of the attributes you want to return from the entities which match the search criteria. For example, you want to get the sn and givenName attributes of the persons who is in marketing department.
- searchBases
- is a list of the search bases used to limit the search to those bases specified in the list.
- countLimit
- is used to specify the maximum number of search results returned by the search operation.
- timeLimit
- If the profile repository supports timeLimit, it specifies in milliseconds the maximum duration of the search.
- expression
- is the search expression in XPath format.
- level
- is used for indicating the level of the hierarchy to be returned. It has different meanings in different contexts. For example, in DescendantControl, it indicates the level of descendants. In GroupMembershipControl, it indicates the level of nested groups.
XML schema definition
The following is the XML schema
definition for the HierarchyControl DataObject.
<xsd:complexType name="HierarchyControl">
<xsd:complexContent>
<xsd:extension base="SearchControl">
<xsd:attribute name="level" type="xsd:int" default="1" />
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
Sample data object
Because HierarchyControl is an abstract control, it does not have sample data object.