Skip navigation links

oracle.oud.types
Enum SearchScope

java.lang.Object
java.lang.Enum<SearchScope>
oracle.oud.types.SearchScope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SearchScope>

public enum SearchScope

extends java.lang.Enum<SearchScope>

A Search operation search scope as defined in RFC 4511 section 4.5.1.2 is used to specify the scope of a Search operation.

See Also:

RFC 4511 - Lightweight Directory Access Protocol (LDAP): The Protocol , draft-sermersheim-ldap-subordinate-scope - Subordinate Subtree Search Scope for LDAP

Enum Constant Summary

BASE_OBJECT
The scope is constrained to the search base entry.

SINGLE_LEVEL
The scope is constrained to the immediate subordinates of the search base entry.

SUBORDINATES
The scope is constrained to all the subordinates of the search base entry, but does not include the search base entry itself (as wholeSubtree does).

WHOLE_SUBTREE
The scope is constrained to the search base entry and to all its subordinates.

Method Summary

int	intValue() Returns the integer value of this search scope as defined in RFC 4511 section 4.5.1.2.
java.lang.String	toString() Returns the string representation of this search scope as defined in RFC 4516.
static SearchScope	valueOf(int intValue) Returns the search scope having the specified integer value as defined in RFC 4511 section 4.5.1.2.
static SearchScope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SearchScope[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BASE_OBJECT

public static final SearchScope BASE_OBJECT

The scope is constrained to the search base entry.

SINGLE_LEVEL

public static final SearchScope SINGLE_LEVEL

The scope is constrained to the immediate subordinates of the search base entry.

WHOLE_SUBTREE

public static final SearchScope WHOLE_SUBTREE

The scope is constrained to the search base entry and to all its subordinates.

SUBORDINATES

public static final SearchScope SUBORDINATES

The scope is constrained to all the subordinates of the search base entry, but does not include the search base entry itself (as wholeSubtree does).

Method Detail

values

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

Returns:

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

valueOf

public static SearchScope valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

valueOf

public static SearchScope valueOf(int intValue)

Returns the search scope having the specified integer value as defined in RFC 4511 section 4.5.1.2.

Parameters:

intValue - The integer value of the search scope.

Returns:

The search scope, or null if there was no search scope associated with intValue.

intValue

public int intValue()

Returns the integer value of this search scope as defined in RFC 4511 section 4.5.1.2.

Returns:

The integer value of this search scope.

toString

public java.lang.String toString()

Returns the string representation of this search scope as defined in RFC 4516.

Overrides:

toString in class java.lang.Enum<SearchScope>

Returns:

The string representation of this search scope.

Skip navigation links