Skip navigation links

oracle.oud.controls
Interface ServerSideSortRequestControl

All Superinterfaces:

Control

public interface ServerSideSortRequestControl

extends Control

The server-side sort request control as defined in RFC 2891. This control may be included in a search request to indicate that search result entries should be sorted by the server before being returned. The sort order is specified using one or more sort keys, the first being the primary key, and so on.

This controls may be useful when the client has limited functionality or for some other reason cannot sort the results but still needs them sorted. In cases where the client can sort the results client-side sorting is recommended in order to reduce load on the server. See SortKey for more an example of client-side sorting.

See Also:

ServerSideSortResponseControl, SortKey, RFC 2891 - LDAP Control Extension for Server Side Sorting of Search Results

Field Summary

static ControlDecoder<ServerSideSortRequestControl>

DECODER A decoder which can be used for decoding the server-side sort request control.

Method Summary

java.util.List<SortKey>

getSortKeys() Returns an unmodifiable list containing the sort keys associated with this server side sort request control.

Methods inherited from interface oracle.oud.controls.Control

getAPIValue, getOID, hasValue, isCritical

Field Detail

DECODER

static final ControlDecoder<ServerSideSortRequestControl> DECODER

A decoder which can be used for decoding the server-side sort request control.

Method Detail

getSortKeys

java.util.List<SortKey> getSortKeys()

Returns an unmodifiable list containing the sort keys associated with this server side sort request control. The list will contain at least one sort key.

Returns:

An unmodifiable list containing the sort keys associated with this server side sort request control.

Skip navigation links