SortControl 数据对象

SortControl 指定对返回的搜索结果的排序方式。

SortControl 数据对象的结构由以下内容组成:
locale
指示在排序操作期间使用的语言。
sortKeys
每个 sortKey 数据对象包含两个用于执行排序的属性。
property
包含用于执行排序的属性的列表。SortControl 中包含的属性必须列出在 SearchControl 的属性列表中。
ascendingOrder
指定每个属性的排序顺序。如果设置为 true,那么将按照升序顺序对搜索结果进行排序。如果设置为 false,那么将按照降序顺序对搜索结果进行排序。例如,如果 virtual member manager 调用者希望按降序顺序对“sn”的搜索结果进行排序,那么调用者需要将 ascendingOrder 设置为 false。

XML 模式定义

以下是 SortControl 数据对象的 XML 模式定义:
<xsd:complexType name="SortControl">
 <xsd:complexContent>
	<xsd:extension base="Control">
   <xsd:sequence>
	  <xsd:element name="sortKeys" type="SortKeyType" minOccurs="0" maxOccurs="unbounded"/>
	  <xsd:element name="locale" type="xsd:language" />
		 </xsd:sequence>
	  </xsd:extension>
   </xsd:complexContent>
	</xsd:complexType>

样本数据对象

以下是 search API 的一个样本 SortControl 数据对象。搜索结果按照 sn (surname) 进行排序,且语言环境设置为英语。
<wim:controls xsi:type="wim:SortControl">
      <wim:sortKeys>
        <wim:propertyName>sn</wim:propertyName>
        <wim:ascendingOrder>false</wim:ascendingOrder>
      </wim:sortKeys>
      <wim:locale>en-US</wim:locale>
</wim:controls>
以下是 search API 的一个样本 SortControl 数据对象。搜索结果首先按照 sn 进行排序,且语言环境设置为英语。如果存在具有相同 sn 的多个结果,那么将按照 givenName(英语)进行排序。
<wim:controls xsi:type="wim:SortControl">
      <wim:sortKeys>
        <wim:propertyName>sn</wim:propertyName>
        <wim:ascendingOrder>false</wim:ascendingOrder>
      </wim:sortKeys>
      <sortKeys>
        <propertyName>givenName</propertyName>
        <ascendingOrder>false</ascendingOrder>
      </sortKeys>
      <wim:locale>en-US</wim:locale>
</wim:controls>


使用条款 | 反馈