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 * http://www.opensource.org/licenses/cddl1.php.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file. If applicable, add the following below this CDDL HEADER,
016 * with the fields enclosed by brackets "[]" replaced with your own
017 * identifying information:
018 *      Portions Copyright [yyyy] [name of copyright owner]
019 *
020 * CDDL HEADER END
021 *
022 *
023 *      Copyright 2014-2021 Ping Identity Corporation
024 */
025package com.unboundid.directory.sdk.common.types;
026
027import com.unboundid.directory.sdk.common.api.OperationCompletedListener;
028import com.unboundid.util.NotExtensible;
029import com.unboundid.util.ThreadSafety;
030import com.unboundid.util.ThreadSafetyLevel;
031
032/**
033 * This interface is used to mark an object which has been registered with the
034 * server as an operation completed listener. This is used to cancel a
035 * previously registered operation completed listener.
036 */
037@NotExtensible
038@ThreadSafety(level = ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
039public interface RegisteredOperationCompletedListener {
040  /**
041   * Retrieves a reference to the operation completed listener that was
042   * registered with the server.
043   *
044   * @return  A reference to the operation completed listener that was
045   *          registered with the server.
046   */
047  OperationCompletedListener getOperationCompletedListener();
048}