net.java.sip.communicator.service.ldap
Interface LdapSearchSettings

All Superinterfaces:

LdapConstants

All Known Implementing Classes:

LdapSearchSettingsImpl

public interface LdapSearchSettings
extends LdapConstants

LdapSearchSettings is a wrapper around all settings a directory search. Each setting has a getter, a setter, and isEnabled method so that the LdapServer can choose defaults when a value isn't set.

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

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.

Method Detail

isMaxResultsSet

boolean isMaxResultsSet()

If results set has reach maximum number.

Returns:

true if results set has reach maximum number, false otherwise

setMaxResults

void setMaxResults(int maxResults)

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

Parameters:

maxResults - the maximum number of results

getMaxResults

int getMaxResults()

Returns the maximum number of results to fetch from the directory when performing the search query. The returned value makes sense only if isMaxResultsSet is true.

Returns:

the maximum number of results

isScopeSet

boolean isScopeSet()

If scope has been set.

Returns:

true if scope has been set, false otherwise

setScope

void setScope(LdapConstants.Scope scope)

Sets a custom search scope.

Parameters:

scope - a custom search scope

getScope

LdapConstants.Scope getScope()

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

Returns:

the custom search scope

isDelaySet

boolean isDelaySet()

If delay has been configured.

Returns:

true if delay has been configured, false otherwise

setDelay

void setDelay(int delay)

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)

Parameters:

delay - a delay before the actual search

getDelay

int getDelay()

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

Returns:

the delay before the search