Package org.apache.directory.api.ldap.extras.controls.vlv

Enum VirtualListViewResultCode

java.lang.Object

java.lang.Enum<VirtualListViewResultCode>

org.apache.directory.api.ldap.extras.controls.vlv.VirtualListViewResultCode

All Implemented Interfaces:

Serializable, Comparable<VirtualListViewResultCode>

public enum VirtualListViewResultCode
extends Enum<VirtualListViewResultCode>

Enumeration of the result codes of a Virtual List View response control as specified in draft-ietf-ldapext-ldapv3-vlv-09.

Author:

Apache Directory Project

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADMINLIMITEXCEEDED	The admin limit has been exceeded
INAPPROPRIATEMATCHING	The matching rule is inappropriate
INSUFFICIENTACCESSRIGHTS	The access right are insufficient
OFFSETRANGEERROR	The offset is incorrect
OPENLDAP_RANGEERRROR	The range is invalid
OPENLDAP_SSSMISSING	SS is missing
OPERATIONSERROR	The operation failed dur to some internal error
OTHER	Another error
SORTCONTROLMISSING	No Sort Control provided
SUCCESS	A success
TIMELIMITEXCEEDED	teh time limit has been exceeded
UNWILLINGTOPERFORM	Unwilling to perform the operation

Method Summary

Modifier and Type	Method	Description
static VirtualListViewResultCode	get(int code)	returns the enum value representing the given code.
String	getDesc()
int	getValue()
static VirtualListViewResultCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static VirtualListViewResultCode[]	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 VirtualListViewResultCode SUCCESS

A success

OPERATIONSERROR

public static final VirtualListViewResultCode OPERATIONSERROR

The operation failed dur to some internal error

TIMELIMITEXCEEDED

public static final VirtualListViewResultCode TIMELIMITEXCEEDED

teh time limit has been exceeded

ADMINLIMITEXCEEDED

public static final VirtualListViewResultCode ADMINLIMITEXCEEDED

The admin limit has been exceeded

INAPPROPRIATEMATCHING

public static final VirtualListViewResultCode INAPPROPRIATEMATCHING

The matching rule is inappropriate

INSUFFICIENTACCESSRIGHTS

public static final VirtualListViewResultCode INSUFFICIENTACCESSRIGHTS

The access right are insufficient

UNWILLINGTOPERFORM

public static final VirtualListViewResultCode UNWILLINGTOPERFORM

Unwilling to perform the operation

SORTCONTROLMISSING

public static final VirtualListViewResultCode SORTCONTROLMISSING

No Sort Control provided

OFFSETRANGEERROR

public static final VirtualListViewResultCode OFFSETRANGEERROR

The offset is incorrect

OPENLDAP_SSSMISSING

public static final VirtualListViewResultCode OPENLDAP_SSSMISSING

SS is missing

OPENLDAP_RANGEERRROR

public static final VirtualListViewResultCode OPENLDAP_RANGEERRROR

The range is invalid

OTHER

public static final VirtualListViewResultCode OTHER

Another error

Method Detail

values

public static VirtualListViewResultCode[] 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 (VirtualListViewResultCode c : VirtualListViewResultCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static VirtualListViewResultCode 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

getValue

public int getValue()

Returns:

The associated integer value

getDesc

public String getDesc()

Returns:

The associated description

get

public static VirtualListViewResultCode 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.