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.types.operation;
018
019
020
021/**
022 * This class defines a set of methods that are available for use by
023 * pre-parse plugins for abandon operations.  Note that this interface
024 * is intended only to define an API for use by plugins and is not
025 * intended to be implemented by any custom classes.
026 */
027@org.opends.server.types.PublicAPI(
028     stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
029     mayInstantiate=false,
030     mayExtend=false,
031     mayInvoke=true)
032public interface PreParseAbandonOperation
033       extends PreParseOperation
034{
035  /**
036   * Retrieves the message ID of the operation that should be
037   * abandoned.
038   *
039   * @return  The message ID of the operation that should be
040   *          abandoned.
041   */
042  int getIDToAbandon();
043}
044