View Javadoc

1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *  
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *  
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License. 
18   *  
19   */
20  package org.apache.directory.server.core.filtering;
21  
22  
23  import java.util.List;
24  
25  import org.apache.directory.server.core.cursor.Cursor;
26  import org.apache.directory.server.core.entry.ClonedServerEntry;
27  import org.apache.directory.server.core.interceptor.context.SearchingOperationContext;
28  
29  
30  /**
31   * 
32   * TODO Add Javadoc !
33   *
34   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
35   * @version $Rev$, $Date$
36   */
37  public interface EntryFilteringCursor extends Cursor<ClonedServerEntry>
38  {
39  
40      /**
41       * Gets whether or not this BaseEntryFilteringCursor has been abandoned.
42       *
43       * @return true if abandoned, false if not
44       */
45      public abstract boolean isAbandoned();
46  
47  
48      /**
49       * Sets whether this BaseEntryFilteringCursor has been abandoned.
50       *
51       * @param abandoned true if abandoned, false if not
52       */
53      public abstract void setAbandoned( boolean abandoned );
54  
55  
56      /**
57       * Adds an entry filter to this BaseEntryFilteringCursor at the very end of 
58       * the filter list.  EntryFilters are applied in the order of addition.
59       * 
60       * @param filter a filter to apply to the entries
61       * @return the result of {@link List#add(Object)}
62       */
63      public abstract boolean addEntryFilter( EntryFilter filter );
64  
65  
66      /**
67       * Removes an entry filter to this BaseEntryFilteringCursor at the very end of 
68       * the filter list.  
69       * 
70       * @param filter a filter to remove from the filter list
71       * @return the result of {@link List#remove(Object)}
72       */
73      public abstract boolean removeEntryFilter( EntryFilter filter );
74  
75  
76      /**
77       * Gets an unmodifiable list of EntryFilters applied.
78       *
79       * @return an unmodifiable list of EntryFilters applied
80       */
81      public abstract List<EntryFilter> getEntryFilters();
82  
83  
84      /**
85       * @return the operationContext
86       */
87      public abstract SearchingOperationContext getOperationContext();
88  }