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
21 package org.apache.directory.api.ldap.model.cursor;
22
23
24 import org.apache.directory.api.ldap.model.entry.Entry;
25 import org.apache.directory.api.ldap.model.message.SearchResultDone;
26
27
28 /**
29 * An extension of Cursor which returns only Entry objects and includes the retrieval of the SearchResultDone.
30 *
31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32 */
33 public interface EntryCursor extends Cursor<Entry>
34 {
35 /**
36 * gives the SearchResultDone message received at the end of search results
37 *
38 * @return the SearchResultDone message, null if the search operation fails for any reason
39 */
40 SearchResultDone getSearchResultDone();
41
42
43 /**
44 * @return the underlying message ID
45 */
46 int getMessageId();
47 }