SortControl especifica como os resultados de procura retornados devem ser
classificados.
A estrutura de um objeto de dados SortControl consiste em:
- código do idioma
- indica o idioma utilizado durante a operação de classificação.
- sortKeys
- Cada objeto de dados
sortKey contém duas propriedades utilizadas para fazer a classificação:
- propriedade
- contém uma lista de atributos que são utilizados para fazer a classificação. Os atributos incluídos no SortControl podem ser listados na
lista de propriedade do SearchControl.
- ascendingOrder
- especifica a ordem de classificação para cada atributo. Se configurado como
true, os resultados da procura são classificados em ordem crescente. Se configurado como false, os resultados da procura são classificados em ordem
decrescente. Por exemplo, se um responsável pela chamada do virtual member manager deseja classificar os resultados da procura por “sn” em ordem
decrescente, o responsável pela chamada precisa configurar a ascendingOrder
como false.
Definição de Esquema XML
A seguir, está a definição de esquema XML para o SortControl DataObject:
<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>
Objeto de Dados de Amostra
A seguir, um objeto de dados SortControl de amostra para a API de procura. Os resultados da procura são classificados por sn (sobrenome) com o código do
idioma configurado como inglês.
<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>
A seguir, um objeto de dados SortControl de amostra para a API de procura. Os resultados
da procura são classificados primeiro por sn com o código do idioma configurado como
inglês. Se vários resultados com o mesmo sn existirem, os resultados serão classificados
por givenName em inglês.
<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>