ldap/model/src/main/java/org/apache/directory/shared/ldap/model/message/AbandonRequest.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */
package org.apache.directory.shared.ldap.model.message;

import org.apache.directory.shared.ldap.model.exception.MessageException;


/**
 * Abandon protocol operation request to terminate an operation already in
 * progress.
 * 
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public interface AbandonRequest extends Request
{
    /** Ldap abandon request type code */
    MessageTypeEnum TYPE = MessageTypeEnum.ABANDON_REQUEST;


    /**
     * Gets the id of the request operation to terminate.
     * 
     * @return the id of the request message to abandon
     */
    int getAbandoned();


    /**
     * Sets the id of the request operation to terminate.
     * 
     * @param requestId the sequence id of the request message to abandon
     * @return The AbandonRequest instance
     */
    AbandonRequest setAbandoned( int requestId );


    /**
     * {@inheritDoc}
     */
    AbandonRequest setMessageId( int messageId );
    
    
    /**
     * {@inheritDoc}
     */
    AbandonRequest addControl( Control control ) throws MessageException;
    
    
    /**
     * {@inheritDoc}
     */
    AbandonRequest addAllControls( Control[] controls ) throws MessageException;
    
    
    /**
     * {@inheritDoc}
     */
    AbandonRequest removeControl( Control control ) throws MessageException;
}