org.apache.ldap.clients.embedded
Class LdapSearchParameters

java.lang.Object
  org.apache.ldap.clients.embedded.LdapSearchParameters

public class LdapSearchParameters
extends java.lang.Object

Class to hold the parameters for a search operation.

Constructor Summary

LdapSearchParameters()

Method Summary

java.lang.String	getBase() Get the base DN to start the search from
java.lang.String	getFilter() Get the search filter in a string format
int	getMaxEntries()
int	getMaxTime()
ScopeEnum	getScope() Get the Scope for the search
boolean	isQuietMode()
boolean	isTypesMode()
void	setBase(java.lang.String a_string) Get the base DN to start the search from
void	setFilter(java.lang.String a_string) Set the search filter
void	setMaxEntries(int a_maxEntries)
void	setMaxTime(int a_maxTime)
void	setQuietMode(boolean a_b)
void	setScope(ScopeEnum a_enum) Set the Scope for the search
void	setTypesMode(boolean a_b)

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapSearchParameters

public LdapSearchParameters()

Method Detail

getBase

public java.lang.String getBase()

Get the base DN to start the search from

Returns:

DN to start the search from

getFilter

public java.lang.String getFilter()

Get the search filter in a string format

Returns:

Search filter

setBase

public void setBase(java.lang.String a_string)

Get the base DN to start the search from

Parameters:

a_string - DN to start the search from

setFilter

public void setFilter(java.lang.String a_string)

Set the search filter

Parameters:

a_string - Search Filter

getScope

public ScopeEnum getScope()

Get the Scope for the search

Returns:

Search Scope: BASEOBJECT - only the base DN SINGLELEVEL - only the current subtree level WHOLESUBTREE - the entire tree

setScope

public void setScope(ScopeEnum a_enum)

Set the Scope for the search

Parameters:

a_enum - Search Scope: BASEOBJECT - only the base DN SINGLELEVEL - only the current subtree level WHOLESUBTREE - the entire tree

isQuietMode

public boolean isQuietMode()

Returns:

setQuietMode

public void setQuietMode(boolean a_b)

Parameters:

a_b -

isTypesMode

public boolean isTypesMode()

Returns:

setTypesMode

public void setTypesMode(boolean a_b)

Parameters:

a_b -

setMaxEntries

public void setMaxEntries(int a_maxEntries)

getMaxEntries

public int getMaxEntries()

setMaxTime

public void setMaxTime(int a_maxTime)

getMaxTime

public int getMaxTime()