001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * docs/licenses/cddl.txt
011     * or http://www.opensource.org/licenses/cddl1.php.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * docs/licenses/cddl.txt.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2010-2012 UnboundID Corp.
026     */
027    package com.unboundid.directory.sdk.common.types;
028    
029    
030    
031    import com.unboundid.util.NotExtensible;
032    import com.unboundid.util.ThreadSafety;
033    import com.unboundid.util.ThreadSafetyLevel;
034    
035    
036    
037    /**
038     * This interface defines a set of methods that may be used to obtain
039     * information about a search operation for which processing has been completed.
040     */
041    @NotExtensible()
042    @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
043    public interface CompletedSearchOperationContext
044           extends CompletedOperationContext
045    {
046      /**
047       * Retrieves the number of entries that were returned to the client during
048       * the course of the search.
049       *
050       * @return  The number of entries that were returned to the client during the
051       *          course of the search.
052       */
053      long getEntryCount();
054    
055    
056    
057      /**
058       * Retrieves the number of references that were returned to the client during
059       * the course of the search.
060       *
061       * @return  The number of references that were returned to the client during
062       *          the course of the search.
063       */
064      long getReferenceCount();
065    
066    
067    
068      /**
069       * Indicates whether the search operation was considered unindexed.
070       *
071       * @return  {@code true} if the search operation was considered unindexed, or
072       *          {@code false} if not.
073       */
074      boolean isUnindexed();
075    }