net.java.sip.communicator.impl.ldap
Class LdapSearchSettingsImpl

java.lang.Object
  net.java.sip.communicator.impl.ldap.LdapSearchSettingsImpl

All Implemented Interfaces:

LdapConstants, LdapSearchSettings

public class LdapSearchSettingsImpl
extends Object
implements LdapSearchSettings

LDAP Settings.

Author:

Sebastien Mazy

Nested Class Summary

Nested classes/interfaces inherited from interface net.java.sip.communicator.service.ldap.LdapConstants

LdapConstants.Auth, LdapConstants.Encryption, LdapConstants.Scope

Field Summary

Fields inherited from interface net.java.sip.communicator.service.ldap.LdapConstants

LDAP_CONNECT_TIMEOUT, LDAP_READ_TIMEOUT

Constructor Summary

LdapSearchSettingsImpl()

Method Summary

int	getDelay() Returns the delay before the search.
int	getMaxResults() Returns the maximum number of results to fetch from the directory when performing the search query.
LdapConstants.Scope	getScope() Returns the custom search scope.
boolean	isDelaySet() If delay has been configured.
boolean	isMaxResultsSet() If results set has reach maximum number.
boolean	isScopeSet() If scope has been set.
void	setDelay(int delay) Sets a delay before performing the "real" search.
void	setMaxResults(int maxResults) Sets the maximum number of results to fetch from the directory when performing the search query.
void	setScope(LdapConstants.Scope scope) Sets a custom search scope.

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapSearchSettingsImpl

public LdapSearchSettingsImpl()

Method Detail

isMaxResultsSet

public boolean isMaxResultsSet()

Description copied from interface: LdapSearchSettings

If results set has reach maximum number.

Specified by:

isMaxResultsSet in interface LdapSearchSettings

Returns:

true if results set has reach maximum number, false otherwise

setMaxResults

public void setMaxResults(int maxResults)

Sets the maximum number of results to fetch from the directory when performing the search query.

Specified by:

setMaxResults in interface LdapSearchSettings

Parameters:

maxResults - the maximum number of results

getMaxResults

public int getMaxResults()

Returns the maximum number of results to fetch from the directory when performing the search query.

Specified by:

getMaxResults in interface LdapSearchSettings

Returns:

the maximum number of results

isScopeSet

public boolean isScopeSet()

Description copied from interface: LdapSearchSettings

If scope has been set.

Specified by:

isScopeSet in interface LdapSearchSettings

Returns:

true if scope has been set, false otherwise

setScope

public void setScope(LdapConstants.Scope scope)

Description copied from interface: LdapSearchSettings

Sets a custom search scope.

Specified by:

setScope in interface LdapSearchSettings

Parameters:

scope - a custom search scope

getScope

public LdapConstants.Scope getScope()

Description copied from interface: LdapSearchSettings

Returns the custom search scope. The returned value makes sense only if isScopeSet is true.

Specified by:

getScope in interface LdapSearchSettings

Returns:

the custom search scope

isDelaySet

public boolean isDelaySet()

Description copied from interface: LdapSearchSettings

If delay has been configured.

Specified by:

isDelaySet in interface LdapSearchSettings

Returns:

true if delay has been configured, false otherwise

setDelay

public void setDelay(int delay)

Description copied from interface: LdapSearchSettings

Sets a delay before performing the "real" search. (to give a chance to cancel the search using LdapQuery.setState() before the search has actually been started)

Specified by:

setDelay in interface LdapSearchSettings

Parameters:

delay - a delay before the actual search

getDelay

public int getDelay()

Description copied from interface: LdapSearchSettings

Returns the delay before the search. This value makes sense only if isDelaySet() is true.

Specified by:

getDelay in interface LdapSearchSettings

Returns:

the delay before the search