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

Interface SortResponse

All Superinterfaces:

Control

All Known Implementing Classes:

SortResponseImpl

public interface SortResponse
extends Control

 SortResult ::= SEQUENCE {
           sortResult  ENUMERATED {
           success                   (0), -- results are sorted
           operationsError           (1), -- server internal failure
           timeLimitExceeded         (3), -- timelimit reached before sorting was completed
           strongAuthRequired        (8), -- refused to return sorted results via insecure protocol
           adminLimitExceeded       (11), -- too many matching entries for the server to sort
           noSuchAttribute          (16), -- unrecognized attribute type in sort key
           inappropriateMatching    (18), -- unrecognized or inappropriate matching rule in sort key
           insufficientAccessRights (50), -- refused to return sorted results to this client
           busy                     (51), -- too busy to process
           unwillingToPerform       (53), -- unable to sort
           other                    (80)

           },
       attributeType [0] AttributeDescription OPTIONAL }
 

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field	Description
static String	OID	the OID of the response control

Method Summary

Modifier and Type	Method	Description
String	getAttributeName()
SortResultCode	getSortResult()
void	setAttributeName(String attributeName)	Sets the name of the first offending attribute
void	setSortResult(SortResultCode result)	sets the sort result

Methods inherited from interface org.apache.directory.api.ldap.model.message.Control

getOid, isCritical, setCritical

Field Detail

OID

static final String OID

the OID of the response control

See Also:

Constant Field Values

Method Detail

setSortResult

void setSortResult(SortResultCode result)

sets the sort result

Parameters:

result - The sort result code

getSortResult

SortResultCode getSortResult()

Returns:

the sort result

setAttributeName

void setAttributeName(String attributeName)

Sets the name of the first offending attribute

Parameters:

attributeName - The attribute's name

getAttributeName

String getAttributeName()

Returns:

the name of the first offending attribute