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 * trunk/ds/resource/legal-notices/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 * trunk/ds/resource/legal-notices/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 2014-2016 UnboundID Corp.
026 */
027package com.unboundid.directory.sdk.common.types;
028
029import com.unboundid.directory.sdk.common.api.OperationCompletedListener;
030import com.unboundid.util.NotExtensible;
031import com.unboundid.util.ThreadSafety;
032import com.unboundid.util.ThreadSafetyLevel;
033
034/**
035 * This interface is used to mark an object which has been registered with the
036 * server as an operation completed listener. This is used to cancel a
037 * previously registered operation completed listener.
038 */
039@NotExtensible
040@ThreadSafety(level = ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
041public interface RegisteredOperationCompletedListener {
042  /**
043   * Retrieves a reference to the operation completed listener that was
044   * registered with the server.
045   *
046   * @return  A reference to the operation completed listener that was
047   *          registered with the server.
048   */
049  OperationCompletedListener getOperationCompletedListener();
050}