Uses of Class
org.forgerock.opendj.ldap.SearchScope

Packages that use SearchScope

Package	Description
org.forgerock.opendj.ldap	Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.opendj.ldap.requests	Classes and interfaces for core LDAP requests.

Uses of SearchScope in org.forgerock.opendj.ldap

Fields in org.forgerock.opendj.ldap declared as SearchScope

Modifier and Type	Field	Description
static final SearchScope	SearchScope.BASE_OBJECT	The scope is constrained to the search base entry.
static final SearchScope	SearchScope.SINGLE_LEVEL	The scope is constrained to the immediate subordinates of the search base entry.
static final SearchScope	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).
static final SearchScope	SearchScope.WHOLE_SUBTREE	The scope is constrained to the search base entry and to all its subordinates.

Methods in org.forgerock.opendj.ldap that return SearchScope

Modifier and Type	Method	Description
SearchScope	LDAPUrl.getScope()	Returns the search scope associated with this LDAP URL.
static SearchScope	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	SearchScope.valueOf(String name)	Returns the search scope having the specified name as defined in RFC 4511 section 4.5.1.2.

Methods in org.forgerock.opendj.ldap that return types with arguments of type SearchScope

Modifier and Type	Method	Description
static List<SearchScope>	SearchScope.values()	Returns an unmodifiable list containing the set of available search scopes indexed on their integer value as defined in RFC 4511 section 4.5.1.2.

Methods in org.forgerock.opendj.ldap with parameters of type SearchScope

Modifier and Type	Method	Description
boolean	DN.isInScopeOf(String dn, SearchScope scope)	Returns true if this DN matches the provided base DN and search scope.
boolean	DN.isInScopeOf(DN dn, SearchScope scope)	Returns true if this DN matches the provided base DN and search scope.
ConnectionEntryReader	AbstractConnection.search(String baseObject, SearchScope scope, String filter, String... attributeDescriptions)
ConnectionEntryReader	AbstractConnectionWrapper.search(String baseObject, SearchScope scope, String filter, String... attributeDescriptions)	Searches the Directory Server using the provided search parameters.
ConnectionEntryReader	Connection.search(String baseObject, SearchScope scope, String filter, String... attributeDescriptions)	Searches the Directory Server using the provided search parameters.
SearchResultEntry	AbstractConnection.searchSingleEntry(String baseObject, SearchScope scope, String filter, String... attributeDescriptions)
SearchResultEntry	AbstractConnectionWrapper.searchSingleEntry(String baseObject, SearchScope scope, String filter, String... attributeDescriptions)	Searches the Directory Server for a single entry using the provided search parameters.
SearchResultEntry	Connection.searchSingleEntry(String baseObject, SearchScope scope, String filter, String... attributeDescriptions)	Searches the Directory Server for a single entry using the provided search parameters.

Constructors in org.forgerock.opendj.ldap with parameters of type SearchScope

Modifier	Constructor	Description
	LDAPUrl(boolean isSecured, String host, Integer port, DN name, SearchScope scope, Filter filter, String... attributes)	Creates a new LDAP URL including the full set of parameters for a search request.

Uses of SearchScope in org.forgerock.opendj.ldap.requests

Methods in org.forgerock.opendj.ldap.requests that return SearchScope

Modifier and Type	Method	Description
SearchScope	SearchRequest.getScope()	Returns the scope of the search.

Methods in org.forgerock.opendj.ldap.requests with parameters of type SearchScope

Modifier and Type	Method	Description
static SearchRequest	Requests.newSearchRequest(String name, SearchScope scope, String filter, String... attributeDescriptions)	Creates a new search request using the provided distinguished name, scope, and filter, decoded using the default schema.
static SearchRequest	Requests.newSearchRequest(DN name, SearchScope scope, Filter filter, String... attributeDescriptions)	Creates a new search request using the provided distinguished name, scope, and filter.
static SearchRequest	Requests.newSingleEntrySearchRequest(String name, SearchScope scope, String filter, String... attributeDescriptions)	Creates a new search request for a single entry, using the provided distinguished name, scope, and filter, decoded using the default schema.
static SearchRequest	Requests.newSingleEntrySearchRequest(DN name, SearchScope scope, Filter filter, String... attributeDescriptions)	Creates a new search request for a single entry, using the provided distinguished name, scope, and filter.
SearchRequest	SearchRequest.setScope(SearchScope scope)	Sets the scope of the search.