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 legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
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 and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2006-2008 Sun Microsystems, Inc.
025 *      Portions Copyright 2015 ForgeRock AS
026 */
027package org.opends.server.types.operation;
028
029
030
031/**
032 * This class defines a set of methods that are available for use by
033 * pre-parse plugins for abandon operations.  Note that this interface
034 * is intended only to define an API for use by plugins and is not
035 * intended to be implemented by any custom classes.
036 */
037@org.opends.server.types.PublicAPI(
038     stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
039     mayInstantiate=false,
040     mayExtend=false,
041     mayInvoke=true)
042public interface PreParseAbandonOperation
043       extends PreParseOperation
044{
045  /**
046   * Retrieves the message ID of the operation that should be
047   * abandoned.
048   *
049   * @return  The message ID of the operation that should be
050   *          abandoned.
051   */
052  int getIDToAbandon();
053}
054