Package com.unboundid.directory.sdk.common.operation

Interface UpdatableSearchRequest

All Superinterfaces:

Request, SearchRequest, UpdatableRequest

@NotExtensible
@ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface UpdatableSearchRequest
extends SearchRequest, UpdatableRequest

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

Method Summary

Modifier and Type	Method	Description
void	setAttributes(java.util.List<java.lang.String> attributes)	Specifies the list of requested attributes.
void	setBaseDN(DN baseDN)	Specifies the base DN for the search.
void	setBaseDN(java.lang.String baseDN)	Specifies the base DN for the search.
void	setDerefPolicy(DereferencePolicy derefPolicy)	Specifies the dereference policy for the search.
void	setFilter(Filter filter)	Specifies the filter for the search.
void	setFilter(java.lang.String filter)	Specifies the filter for the search.
void	setScope(SearchScope scope)	Specifies the scope for the search.
void	setSizeLimit(int sizeLimit)	Specifies the size limit for the search.
void	setTimeLimitSeconds(int timeLimit)	Specifies the time limit for the search in seconds.
void	setTypesOnly(boolean typesOnly)	Specifies whether search result entries should contain attribute values.

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

getOperationType, getRequestControls

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

getAttributes, getBaseDN, getDerefPolicy, getFilter, getScope, getSizeLimit, getTimeLimitSeconds, getTypesOnly, toLDAPSDKRequest

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

addRequestControl, setRequestControls

Method Detail

setBaseDN

void setBaseDN(java.lang.String baseDN)

Specifies the base DN for the search.

Parameters:

baseDN - The base DN for the search. It must not be null.

setBaseDN

void setBaseDN(DN baseDN)

Specifies the base DN for the search.

Parameters:

baseDN - The base DN for the search. It must not be null.

setScope

void setScope(SearchScope scope)

Specifies the scope for the search.

Parameters:

scope - The scope for the search. It must not be null.

setDerefPolicy

void setDerefPolicy(DereferencePolicy derefPolicy)

Specifies the dereference policy for the search.

Parameters:

derefPolicy - The dereference policy for the search. It must not be null.

setSizeLimit

void setSizeLimit(int sizeLimit)

Specifies the size limit for the search. A value less than or equal to zero indicates that no size limit should be requested.

Parameters:

sizeLimit - The size limit for the search.

setTimeLimitSeconds

void setTimeLimitSeconds(int timeLimit)

Specifies the time limit for the search in seconds. A value less than or equal to zero indicates that no time limit should be requested.

Parameters:

timeLimit - The time limit for the search in seconds.

setTypesOnly

void setTypesOnly(boolean typesOnly)

Specifies whether search result entries should contain attribute values.

Parameters:

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

setFilter

void setFilter(Filter filter)

Specifies the filter for the search.

Parameters:

filter - The filter for the search. It must not be null.

setFilter

void setFilter(java.lang.String filter)
        throws LDAPException

Specifies the filter for the search.

Parameters:

filter - The string representation of the filter for the search. It must not be null.

Throws:

LDAPException - If the provided string cannot be parsed as a valid filter.

setAttributes

void setAttributes(java.util.List<java.lang.String> attributes)

Specifies the list of requested attributes.

Parameters:

attributes - The list of requested attributes.