001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2006-2008 Sun Microsystems, Inc.
015 * Portions Copyright 2015 ForgeRock AS.
016 */
017package org.opends.server.core;
018
019import org.opends.server.types.Operation;
020
021
022/**
023 * This class defines an operation that may be used to abandon an operation that
024 * may already be in progress in the Directory Server.
025 */
026public interface AbandonOperation extends Operation
027{
028  /**
029   * Retrieves the message ID of the operation that should be abandoned.
030   *
031   * @return  The message ID of the operation that should be abandoned.
032   */
033  int getIDToAbandon();
034
035}