org.apache.directory.server.core.enumeration
Interface SearchResultFilter
- All Known Implementing Classes:
- SubentryService.HideEntriesFilter, SubentryService.HideSubentriesFilter
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 SearchResultFilteringEnumeration
.
Multiple filters can be applied one after the other and hence they are stackable.
- Version:
- $Rev: 434579 $
- Author:
- Apache Directory Project
Method Summary |
boolean |
accept(Invocation invocation,
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
boolean accept(Invocation invocation,
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 © 2003-2010 Apache Software Foundation. All Rights Reserved.