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.api.ldap.model.message;
021
022
023import org.apache.directory.api.ldap.model.name.Dn;
024
025
026/**
027 * Delete request protocol message used to remove an existing leaf entry from
028 * the directory.
029 * 
030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031 */
032public interface DeleteRequest extends SingleReplyRequest, AbandonableRequest
033{
034    /**
035     * Gets the distinguished name of the leaf entry to be deleted by this
036     * request.
037     * 
038     * @return the Dn of the leaf entry to delete.
039     */
040    Dn getName();
041
042
043    /**
044     * Sets the distinguished name of the leaf entry to be deleted by this
045     * request.
046     * 
047     * @param name the Dn of the leaf entry to delete.
048     * @return The DeleteRequest instance
049     */
050    DeleteRequest setName( Dn name );
051
052
053    /**
054     * {@inheritDoc}
055     */
056    @Override
057    DeleteRequest setMessageId( int messageId );
058
059
060    /**
061     * {@inheritDoc}
062     */
063    @Override
064    DeleteRequest addControl( Control control );
065
066
067    /**
068     * {@inheritDoc}
069     */
070    @Override
071    DeleteRequest addAllControls( Control[] controls );
072
073
074    /**
075     * {@inheritDoc}
076     */
077    @Override
078    DeleteRequest removeControl( Control control );
079}