org.apache.directory.api.ldap.model.message.controls

Interface SortRequest

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 }

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OID the sort request control's OID

Method Summary

Modifier and Type	Method and Description
void	addSortKey(SortKey sortKey) adds a sort key
java.util.List<SortKey>	getSortKeys()
void	setSortKeys(java.util.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 java.lang.String OID

the sort request control's OID

See Also:

Constant Field Values

Method Detail

setSortKeys

void setSortKeys(java.util.List<SortKey> sortKeys)

sets the sort keys

Parameters:

sortKeys -

getSortKeys

java.util.List<SortKey> getSortKeys()

Returns:

the list of sort keys

addSortKey

void addSortKey(SortKey sortKey)

adds a sort key

Parameters:

sortKey -