org.apache.directory.server.core.filtering
Interface EntryFilteringCursor

All Superinterfaces:
org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>, java.lang.Iterable<ClonedServerEntry>
All Known Implementing Classes:
BaseEntryFilteringCursor, CursorList

public interface EntryFilteringCursor
extends org.apache.directory.shared.ldap.cursor.Cursor<ClonedServerEntry>

TODO Add Javadoc !

Version:
$Rev$, $Date$
Author:
Apache Directory Project

Method Summary
 boolean addEntryFilter(EntryFilter filter)
          Adds an entry filter to this BaseEntryFilteringCursor at the very end of the filter list.
 java.util.List<EntryFilter> getEntryFilters()
          Gets an unmodifiable list of EntryFilters applied.
 SearchingOperationContext getOperationContext()
           
 boolean isAbandoned()
          Gets whether or not this BaseEntryFilteringCursor has been abandoned.
 boolean removeEntryFilter(EntryFilter filter)
          Removes an entry filter to this BaseEntryFilteringCursor at the very end of the filter list.
 void setAbandoned(boolean abandoned)
          Sets whether this BaseEntryFilteringCursor has been abandoned.
 
Methods inherited from interface org.apache.directory.shared.ldap.cursor.Cursor
after, afterLast, available, before, beforeFirst, close, close, first, get, isClosed, isElementReused, last, next, previous, setClosureMonitor
 
Methods inherited from interface java.lang.Iterable
iterator
 

Method Detail

isAbandoned

boolean isAbandoned()
Gets whether or not this BaseEntryFilteringCursor has been abandoned.

Returns:
true if abandoned, false if not

setAbandoned

void setAbandoned(boolean abandoned)
Sets whether this BaseEntryFilteringCursor has been abandoned.

Parameters:
abandoned - true if abandoned, false if not

addEntryFilter

boolean addEntryFilter(EntryFilter filter)
Adds an entry filter to this BaseEntryFilteringCursor at the very end of the filter list. EntryFilters are applied in the order of addition.

Parameters:
filter - a filter to apply to the entries
Returns:
the result of List.add(Object)

removeEntryFilter

boolean removeEntryFilter(EntryFilter filter)
Removes an entry filter to this BaseEntryFilteringCursor at the very end of the filter list.

Parameters:
filter - a filter to remove from the filter list
Returns:
the result of List.remove(Object)

getEntryFilters

java.util.List<EntryFilter> getEntryFilters()
Gets an unmodifiable list of EntryFilters applied.

Returns:
an unmodifiable list of EntryFilters applied

getOperationContext

SearchingOperationContext getOperationContext()
Returns:
the operationContext


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.