com.unboundid.directory.sdk.common.operation
Interface SearchRequest

All Superinterfaces:

Request

All Known Subinterfaces:

UpdatableSearchRequest

@NotExtensible
@ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface SearchRequest
extends Request

This interface defines a set of methods which may be used to interact with a search request.

Method Summary

java.util.List<java.lang.String>	getAttributes() Retrieves the list of requested attributes.
java.lang.String	getBaseDN() Retrieves the base DN for the search.
DereferencePolicy	getDerefPolicy() Retrieves the dereference policy for the search.
Filter	getFilter() Retrieves the filter for the search.
SearchScope	getScope() Retrieves the scope for the search.
int	getSizeLimit() Retrieves the size limit for the search.
int	getTimeLimitSeconds() Retrieves the time limit for the search in seconds.
boolean	getTypesOnly() Indicates whether search result entries should contain only attribute types or both types and values.
ReadOnlySearchRequest	toLDAPSDKRequest(SearchResultListener listener) Retrieves an LDAP SDK representation of this search request.

Methods inherited from interface com.unboundid.directory.sdk.common.operation.Request

getOperationType, getRequestControls

Method Detail

getBaseDN

java.lang.String getBaseDN()

Retrieves the base DN for the search.

Returns:

The base DN for the search.

getScope

SearchScope getScope()

Retrieves the scope for the search.

Returns:

The scope for the search.

getDerefPolicy

DereferencePolicy getDerefPolicy()

Retrieves the dereference policy for the search.

Returns:

The dereference policy for the search.

getSizeLimit

int getSizeLimit()

Retrieves the size limit for the search.

Returns:

The size limit for the search, or zero if no size limit should be requested.

getTimeLimitSeconds

int getTimeLimitSeconds()

Retrieves the time limit for the search in seconds.

Returns:

The time limit for the search in seconds, or zero if no time limit should be requested.

getTypesOnly

boolean getTypesOnly()

Indicates whether search result entries should contain only attribute types or both types and values.

Returns:

true if search result entries should contain only attribute types but no values, or false if entries should contain both attribute types and values.

getFilter

Filter getFilter()

Retrieves the filter for the search.

Returns:

The filter for the search.

getAttributes

java.util.List<java.lang.String> getAttributes()

Retrieves the list of requested attributes.

Returns:

The list of requested attributes.

toLDAPSDKRequest

ReadOnlySearchRequest toLDAPSDKRequest(SearchResultListener listener)

Retrieves an LDAP SDK representation of this search request.

Parameters:

listener - The search result listener that should be used for the request. It may be null if no listener should be used.

Returns:

An LDAP SDK representation of this search request.