SortRequest (Apache LDAP API 2.0.0.AM2 API Documentation)

All Superinterfaces:

Control

All Known Implementing Classes:

SortRequestControlImpl, SortRequestDecorator
```
public interface SortRequest
extends Control
```
Implementation of Server Side Sort request control based on the RFC 2891

SortKeyList ::= SEQUENCE OF SEQUENCE {
attributeType AttributeDescription,
orderingRule [0] MatchingRuleId OPTIONAL,
reverseOrder [1] BOOLEAN DEFAULT FALSE }

Author:

Apache Directory Project

Field Summary

Fields
Modifier and Type Field Description

static String OID
the sort request control's OID

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addSortKey(SortKey sortKey)`	adds a sort key
`List<SortKey>`	`getSortKeys()`
`void`	`setSortKeys(List<SortKey> sortKeys)`	sets the sort keys

Methods inherited from interface org.apache.directory.api.ldap.model.message.Control
getOid, isCritical, setCritical

- Field Detail
  - OID
```
static final String OID
```
    the sort request control's OID
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setSortKeys
```
void setSortKeys(List<SortKey> sortKeys)
```
    sets the sort keys
    
    Parameters:
    
    sortKeys - The list of keys to be sorted
  - getSortKeys
```
List<SortKey> getSortKeys()
```
    Returns:
    
    the list of sort keys
  - addSortKey
```
void addSortKey(SortKey sortKey)
```
    adds a sort key
    
    Parameters:
    
    sortKey - The list of keys to be sorted