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.api.filtering;
21
22
23 import java.util.List;
24
25 import org.apache.directory.api.ldap.model.cursor.Cursor;
26 import org.apache.directory.api.ldap.model.entry.Entry;
27 import org.apache.directory.server.core.api.interceptor.context.SearchOperationContext;
28
29
30 /**
31 * A wrapper on top of a Cursor used to filter entries we get from the backend.
32 *
33 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34 */
35 public interface EntryFilteringCursor extends Cursor<Entry>
36 {
37 /**
38 * Adds an entry filter to this BaseEntryFilteringCursor at the very end of
39 * the filter list. EntryFilters are applied in the order of addition.
40 *
41 * @param filter a filter to apply to the entries
42 * @return the result of {@link List#add(Object)}
43 */
44 boolean addEntryFilter( EntryFilter filter );
45
46
47 /**
48 * Gets an unmodifiable list of EntryFilters applied.
49 *
50 * @return an unmodifiable list of EntryFilters applied
51 */
52 List<EntryFilter> getEntryFilters();
53
54
55 /**
56 * @return the operationContext
57 */
58 SearchOperationContext getOperationContext();
59 }