org.apache.ldap.server.db
Interface SearchResultFilter
- public interface SearchResultFilter
A filter is used to modify search results while they are being returned from
naming enumerations containing DbSearchResults. These filters are used in
conjunction with a ResultFilteringEnumeration
. Multiple filters can
be applied one after the other and hence they are stackable.
- Version:
- $Rev: 157708 $
- Author:
- Apache Directory Project
Method Summary |
boolean |
accept(javax.naming.ldap.LdapContext ctx,
javax.naming.directory.SearchResult result,
javax.naming.directory.SearchControls controls)
Filters the contents of search results on the way out the door to client
callers. |
accept
public boolean accept(javax.naming.ldap.LdapContext ctx,
javax.naming.directory.SearchResult result,
javax.naming.directory.SearchControls controls)
throws javax.naming.NamingException
- Filters the contents of search results on the way out the door to client
callers. These filters can and do produce side-effects on the results if
if need be the attributes or names within the result should be cloned.
- Parameters:
result
- the database search result to returncontrols
- search controls associated with the invocation
- Returns:
- true if the result is to be returned, false if it is to be
discarded from the result set
- Throws:
javax.naming.NamingException
Copyright © 2002-2005 . All Rights Reserved.