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

Enum SortResultCode

java.lang.Object

java.lang.Enum<SortResultCode>

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

All Implemented Interfaces:

Serializable, Comparable<SortResultCode>

public enum SortResultCode
extends Enum<SortResultCode>

Enumeration of the result codes of a SortResult defined in RFC 2891 for server side sort control.

Author:

Apache Directory Project

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADMINLIMITEXCEEDED
BUSY
INAPPROPRIATEMATCHING
INSUFFICIENTACCESSRIGHTS
NOSUCHATTRIBUTE
OPERATIONSERROR
OTHER
STRONGAUTHREQUIRED
SUCCESS
TIMELIMITEXCEEDED
UNWILLINGTOPERFORM

Method Summary

Modifier and Type	Method	Description
static SortResultCode	get(int code)	returns the enum value representing the given code.
int	getVal()
static SortResultCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SortResultCode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final SortResultCode SUCCESS

OPERATIONSERROR

public static final SortResultCode OPERATIONSERROR

TIMELIMITEXCEEDED

public static final SortResultCode TIMELIMITEXCEEDED

STRONGAUTHREQUIRED

public static final SortResultCode STRONGAUTHREQUIRED

ADMINLIMITEXCEEDED

public static final SortResultCode ADMINLIMITEXCEEDED

NOSUCHATTRIBUTE

public static final SortResultCode NOSUCHATTRIBUTE

INAPPROPRIATEMATCHING

public static final SortResultCode INAPPROPRIATEMATCHING

INSUFFICIENTACCESSRIGHTS

public static final SortResultCode INSUFFICIENTACCESSRIGHTS

BUSY

public static final SortResultCode BUSY

UNWILLINGTOPERFORM

public static final SortResultCode UNWILLINGTOPERFORM

OTHER

public static final SortResultCode OTHER

Method Detail

values

public static SortResultCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SortResultCode c : SortResultCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SortResultCode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getVal

public int getVal()

Returns:

The internet value

get

public static SortResultCode get(int code)

returns the enum value representing the given code.

Parameters:

code - the result code

Returns:

returns the corresponding ResultCode, throws IllegalArgumentException when there is no matching ResultCode exists for the given value.