Skip navigation links

oracle.oud.controls
Interface ServerSideSortResponseControl

All Superinterfaces:

Control

public interface ServerSideSortResponseControl

extends Control

The server-side sort response control as defined in RFC 2891. This control is included with a search result in response to a server-side sort request included with a search request. The client application is assured that the search results are sorted in the specified key order if and only if the result code in this control is success. If the server omits this control from the search result, the client SHOULD assume that the sort control was ignored by the server.

See Also:

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

Field Summary

static ControlDecoder<ServerSideSortResponseControl>

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

Method Summary

AttributeDescription	getAttributeDescription() Returns the first attribute description specified in the list of sort keys that was in error, or null if the attribute description was not included with this control.
ResultCode	getResult() Returns a result code indicating the outcome of the server-side sort request.

Methods inherited from interface oracle.oud.controls.Control

getAPIValue, getOID, hasValue, isCritical

Field Detail

DECODER

static final ControlDecoder<ServerSideSortResponseControl> DECODER

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

Method Detail

getAttributeDescription

AttributeDescription getAttributeDescription()

Returns the first attribute description specified in the list of sort keys that was in error, or null if the attribute description was not included with this control.

Returns:

The first attribute description specified in the list of sort keys that was in error.

getResult

ResultCode getResult()

Returns a result code indicating the outcome of the server-side sort request. This will be ResultCode.SUCCESS if the search results were sorted in accordance with the keys specified in the server-side sort request control, or an error code indicating why the results could not be sorted (such as ResultCode.NO_SUCH_ATTRIBUTE or ResultCode.INAPPROPRIATE_MATCHING).

Returns:

The result code indicating the outcome of the server-side sort request.

Skip navigation links