|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<SearchScope>
org.opends.server.types.SearchScope
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public enum SearchScope
This enumeration defines the set of possible scopes that may be used for a search request. This is based on the LDAP specification defined in RFC 2251 but also includes the subordinate subtree search scope defined in draft-sermersheim-ldap-subordinate-scope.
Enum Constant Summary | |
---|---|
BASE_OBJECT
The search scope that indicates only the entry specified as the search base should be considered a candidate for matching. |
|
SINGLE_LEVEL
The search scope that indicates only those entries that are immediate children of the entry specified as the search base (and not any of their descendants, and not the search base itself) should be considered candidates for matching. |
|
SUBORDINATE_SUBTREE
The search scope that indicates all descendants (recursively) below the entry specified as the search base (but not the search base entry itself) should be considered candidates for matching. |
|
WHOLE_SUBTREE
The search scope that indicates the entry specified as the search base and all descendants (recursively) should be considered candidates for matching. |
Method Summary | |
---|---|
int |
intValue()
Retrieves the integer value associated with this search scope. |
java.lang.String |
toString()
Retrieves a string representation of this search scope. |
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 |
---|
public static final SearchScope BASE_OBJECT
public static final SearchScope SINGLE_LEVEL
public static final SearchScope WHOLE_SUBTREE
public static final SearchScope SUBORDINATE_SUBTREE
Method Detail |
---|
public static SearchScope[] values()
for (SearchScope c : SearchScope.values()) System.out.println(c);
public static SearchScope valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is nullpublic int intValue()
public java.lang.String toString()
toString
in class java.lang.Enum<SearchScope>
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |