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 */
020package org.apache.directory.shared.ldap.model.message;
021
022import org.apache.directory.shared.ldap.model.exception.MessageException;
023
024
025/**
026 * Abandon protocol operation request to terminate an operation already in
027 * progress.
028 * 
029 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
030 */
031public interface AbandonRequest extends Request
032{
033    /** Ldap abandon request type code */
034    MessageTypeEnum TYPE = MessageTypeEnum.ABANDON_REQUEST;
035
036
037    /**
038     * Gets the id of the request operation to terminate.
039     * 
040     * @return the id of the request message to abandon
041     */
042    int getAbandoned();
043
044
045    /**
046     * Sets the id of the request operation to terminate.
047     * 
048     * @param requestId the sequence id of the request message to abandon
049     * @return The AbandonRequest instance
050     */
051    AbandonRequest setAbandoned( int requestId );
052
053
054    /**
055     * {@inheritDoc}
056     */
057    AbandonRequest setMessageId( int messageId );
058    
059    
060    /**
061     * {@inheritDoc}
062     */
063    AbandonRequest addControl( Control control ) throws MessageException;
064    
065    
066    /**
067     * {@inheritDoc}
068     */
069    AbandonRequest addAllControls( Control[] controls ) throws MessageException;
070    
071    
072    /**
073     * {@inheritDoc}
074     */
075    AbandonRequest removeControl( Control control ) throws MessageException;
076}