001/*
002 *   Licensed to the Apache Software Foundation (ASF) under one
003 *   or more contributor license agreements.  See the NOTICE file
004 *   distributed with this work for additional information
005 *   regarding copyright ownership.  The ASF licenses this file
006 *   to you under the Apache License, Version 2.0 (the
007 *   "License"); you may not use this file except in compliance
008 *   with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *   Unless required by applicable law or agreed to in writing,
013 *   software distributed under the License is distributed on an
014 *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *   KIND, either express or implied.  See the License for the
016 *   specific language governing permissions and limitations
017 *   under the License.
018 *
019 */
020
021package org.apache.directory.api.ldap.model.cursor;
022
023
024import org.apache.directory.api.ldap.model.entry.Entry;
025import org.apache.directory.api.ldap.model.message.SearchResultDone;
026
027
028/**
029 * An extension of Cursor which returns only Entry objects and includes the retrieval of the SearchResultDone. 
030 * 
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 */
033public interface EntryCursor extends Cursor<Entry>
034{
035    /**
036     * gives the SearchResultDone message received at the end of search results
037     * 
038     * @return the SearchResultDone message, null if the search operation fails for any reason 
039     */
040    SearchResultDone getSearchResultDone();
041
042
043    /**
044     * @return the underlying message ID
045     */
046    int getMessageId();
047}