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 2015-2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.broker.types;
028
029
030import com.unboundid.util.NotExtensible;
031
032
033
034/**
035 * This interface defines methods that provide search result objects to a
036 * requester as they are returned from a Store Adapter.
037 */
038@NotExtensible
039public interface StoreSearchResultListener
040{
041  /**
042   * Indicates that the provided object has been returned by the Store Adapter
043   * and may be processed by this result listener.
044   *
045   * @param jsonObject  The JSON object that has been returned by
046   *                    the Store Adapter. This string can be created
047   *                    using any JSON library. For example, the Jackson
048   *                    library's ObjectNode.toString() or the UnboundID
049   *                    LDAP SDK's JSONObject.toString().
050   */
051  void searchResultReturned(final String jsonObject);
052}