001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *  
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *  
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License. 
018     *  
019     */
020    package org.apache.directory.api.ldap.model.message;
021    
022    
023    /**
024     * Abandon protocol operation request to terminate an operation already in
025     * progress.
026     * 
027     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
028     */
029    public interface AbandonRequest extends Request
030    {
031        /** Ldap abandon request type code */
032        MessageTypeEnum TYPE = MessageTypeEnum.ABANDON_REQUEST;
033    
034    
035        /**
036         * Gets the id of the request operation to terminate.
037         * 
038         * @return the id of the request message to abandon
039         */
040        int getAbandoned();
041    
042    
043        /**
044         * Sets the id of the request operation to terminate.
045         * 
046         * @param requestId the sequence id of the request message to abandon
047         * @return The AbandonRequest instance
048         */
049        AbandonRequest setAbandoned( int requestId );
050    }