org.opends.server.protocols.internal

Class SearchRequest

java.lang.Object

org.opends.server.protocols.internal.SearchRequest

public final class SearchRequest
extends Object

Search request implementation.

See Also:

SearchRequest

Method Summary

Methods

Modifier and Type	Method and Description
SearchRequest	addAttribute(Collection<String> attributeDescriptions) To be added to SearchRequest?
SearchRequest	addAttribute(String... attributeDescriptions) To be removed.
SearchRequest	addControl(Collection<Control> controls) To be removed
SearchRequest	addControl(Control control) To be removed
boolean	containsControl(String oid) To be removed
Set<String>	getAttributes() To be removed.
List<Control>	getControls() To be removed
org.forgerock.opendj.ldap.DereferenceAliasesPolicy	getDereferenceAliasesPolicy() To be removed.
SearchFilter	getFilter() To be removed.
DN	getName() To be removed.
org.forgerock.opendj.ldap.SearchScope	getScope() To be removed.
int	getSizeLimit() To be removed.
int	getTimeLimit() To be removed.
boolean	isSingleEntrySearch() To be removed.
boolean	isTypesOnly() To be removed.
SearchRequest	setDereferenceAliasesPolicy(org.forgerock.opendj.ldap.DereferenceAliasesPolicy policy) To be removed.
SearchRequest	setFilter(SearchFilter filter) To be removed.
SearchRequest	setFilter(String filter) To be removed.
SearchRequest	setName(DN dn) To be removed.
SearchRequest	setName(String dn) To be removed.
SearchRequest	setScope(org.forgerock.opendj.ldap.SearchScope scope) To be removed.
SearchRequest	setSizeLimit(int limit) To be removed.
SearchRequest	setTimeLimit(int limit) To be removed.
SearchRequest	setTypesOnly(boolean typesOnly) To be removed.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

addAttribute

public SearchRequest addAttribute(String... attributeDescriptions)

To be removed.

Parameters:

attributeDescriptions - the attribute descriptions

Returns:

the current object

See Also:

SearchRequest.addAttribute(String...)

addAttribute

public SearchRequest addAttribute(Collection<String> attributeDescriptions)

To be added to SearchRequest?

Parameters:

attributeDescriptions - the attribute descriptions

Returns:

the current object

getAttributes

public Set<String> getAttributes()

To be removed.

Returns:

the attributes

See Also:

SearchRequest.getAttributes()

getDereferenceAliasesPolicy

public org.forgerock.opendj.ldap.DereferenceAliasesPolicy getDereferenceAliasesPolicy()

To be removed.

Returns:

the dereference aliases policy

See Also:

SearchRequest.getDereferenceAliasesPolicy()

getFilter

public SearchFilter getFilter()

To be removed.

Returns:

the search filter

See Also:

SearchRequest.getFilter()

getName

public DN getName()

To be removed.

Returns:

the DN

See Also:

SearchRequest.getName()

getScope

public org.forgerock.opendj.ldap.SearchScope getScope()

To be removed.

Returns:

the search scope

See Also:

SearchRequest.getScope()

getSizeLimit

public int getSizeLimit()

To be removed.

Returns:

the size limit

See Also:

SearchRequest.getSizeLimit()

isSingleEntrySearch

public boolean isSingleEntrySearch()

To be removed.

Returns:

is single entry search

See Also:

SearchRequest.isSingleEntrySearch()

getTimeLimit

public int getTimeLimit()

To be removed.

Returns:

the time limit

See Also:

SearchRequest.getTimeLimit()

isTypesOnly

public boolean isTypesOnly()

To be removed.

Returns:

the types only

See Also:

SearchRequest.isTypesOnly()

setDereferenceAliasesPolicy

public SearchRequest setDereferenceAliasesPolicy(org.forgerock.opendj.ldap.DereferenceAliasesPolicy policy)

To be removed.

Parameters:

policy - the dereference aliases policy

Returns:

the current request

See Also:

SearchRequest.setDereferenceAliasesPolicy(DereferenceAliasesPolicy)

setFilter

public SearchRequest setFilter(SearchFilter filter)

To be removed.

Parameters:

filter - the search filter

Returns:

the current request

See Also:

SearchRequest.setFilter(org.forgerock.opendj.ldap.Filter)

setFilter

public SearchRequest setFilter(String filter)
                        throws DirectoryException

To be removed.

Parameters:

filter - the search filter

Returns:

the current request

Throws:

DirectoryException - if problem occurs

See Also:

SearchRequest.setFilter(String)

setName

public SearchRequest setName(DN dn)

To be removed.

Parameters:

dn - the dn

Returns:

the current request

See Also:

SearchRequest.setName(org.forgerock.opendj.ldap.DN)

setName

public SearchRequest setName(String dn)
                      throws DirectoryException

To be removed.

Parameters:

dn - the dn

Returns:

the current request

Throws:

DirectoryException - if problem occurs

See Also:

SearchRequest.setName(String)

setScope

public SearchRequest setScope(org.forgerock.opendj.ldap.SearchScope scope)

To be removed.

Parameters:

scope - the search scope

Returns:

the current request

See Also:

SearchRequest.setScope(SearchScope)

setSizeLimit

public SearchRequest setSizeLimit(int limit)

To be removed.

Parameters:

limit - the size limit

Returns:

the current request

See Also:

SearchRequest.setSizeLimit(int)

setTimeLimit

public SearchRequest setTimeLimit(int limit)

To be removed.

Parameters:

limit - the time limit

Returns:

the current request

See Also:

SearchRequest.setTimeLimit(int)

setTypesOnly

public SearchRequest setTypesOnly(boolean typesOnly)

To be removed.

Parameters:

typesOnly - the types only

Returns:

the current request

See Also:

SearchRequest.setTypesOnly(boolean)

addControl

public SearchRequest addControl(Control control)

To be removed

Parameters:

control - the control

Returns:

the current object

See Also:

AbstractRequestImpl.addControl( org.forgerock.opendj.ldap.controls.Control)

addControl

public SearchRequest addControl(Collection<Control> controls)

To be removed

Parameters:

controls - the controls

Returns:

the current object

See Also:

AbstractRequestImpl.addControl( org.forgerock.opendj.ldap.controls.Control)

toString

public String toString()

containsControl

public boolean containsControl(String oid)

To be removed

Parameters:

oid - the oid

Returns:

the current object

See Also:

AbstractRequestImpl.containsControl(String)

getControls

public final List<Control> getControls()

To be removed

Returns:

the controls

See Also:

AbstractRequestImpl.getControls()