Class BasicAsyncSearchResultListener

    • Constructor Detail

      • BasicAsyncSearchResultListener

        public BasicAsyncSearchResultListener()
        Creates a new instance of this class for use in processing a single search operation. A single basic async search result listener object may not be used for multiple operations.
    • Method Detail

      • searchResultReceived

        @InternalUseOnly
        public void searchResultReceived​(AsyncRequestID requestID,
                                         SearchResult searchResult)
        Indicates that the provided search result has been received in response to an asynchronous search operation. Note that automatic referral following is not supported for asynchronous operations, so it is possible that this result could include a referral.
        Specified by:
        searchResultReceived in interface AsyncSearchResultListener
        Parameters:
        requestID - The async request ID of the request for which the response was received.
        searchResult - The search result that has been received.
      • getSearchResult

        public SearchResult getSearchResult()
        Retrieves the result that has been received for the associated asynchronous search operation, if it has been received.
        Returns:
        The result that has been received for the associated asynchronous search operation, or null if no response has been received yet.
      • getSearchEntries

        public java.util.List<SearchResultEntrygetSearchEntries()
        Retrieves a list of the entries returned for the search operation. This should only be called after the operation has completed and a non-null search result object is available, because it may not be safe to access the contents of the list if it may be altered while the search is still in progress.
        Returns:
        A list of the entries returned for the search operation.
      • getSearchReferences

        public java.util.List<SearchResultReferencegetSearchReferences()
        Retrieves a list of the references returned for the search operation. This should only be called after the operation has completed and a non-null search result object is available, because it may not be safe to access the contents of the list if it may be altered while the search is still in progress.
        Returns:
        A list of the references returned for the search operation.