001    /*
002     * Copyright 2008-2014 UnboundID Corp.
003     * All Rights Reserved.
004     */
005    /*
006     * Copyright (C) 2008-2014 UnboundID Corp.
007     *
008     * This program is free software; you can redistribute it and/or modify
009     * it under the terms of the GNU General Public License (GPLv2 only)
010     * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
011     * as published by the Free Software Foundation.
012     *
013     * This program is distributed in the hope that it will be useful,
014     * but WITHOUT ANY WARRANTY; without even the implied warranty of
015     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016     * GNU General Public License for more details.
017     *
018     * You should have received a copy of the GNU General Public License
019     * along with this program; if not, see <http://www.gnu.org/licenses>.
020     */
021    package com.unboundid.ldap.sdk;
022    
023    
024    
025    
026    
027    
028    /**
029     * This interface provides a mechanism for notifying a client when the search
030     * result done message for an asynchronous search operation has been received.
031     */
032    public interface AsyncSearchResultListener
033           extends SearchResultListener
034    {
035      /**
036       * Indicates that the provided search result has been received in response to
037       * an asynchronous search operation.  Note that automatic referral following
038       * is not supported for asynchronous operations, so it is possible that this
039       * result could include a referral.
040       *
041       * @param  requestID     The async request ID of the request for which the
042       *                       response was received.
043       * @param  searchResult  The search result that has been received.
044       */
045      void searchResultReceived(final AsyncRequestID requestID,
046                                final SearchResult searchResult);
047    }