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.shared.ldap.message.internal;
021    
022    import org.apache.directory.shared.ldap.codec.MessageTypeEnum;
023    import org.apache.directory.shared.ldap.message.SingleReplyRequest;
024    import org.apache.directory.shared.ldap.name.DN;
025    
026    
027    /**
028     * Delete request protocol message used to remove an existing leaf entry from
029     * the directory.
030     * 
031     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032     * @version $Revision: 918756 $
033     */
034    public interface InternalDeleteRequest extends SingleReplyRequest, InternalAbandonableRequest
035    {
036        /** Delete request message type enumeration value */
037        MessageTypeEnum TYPE = MessageTypeEnum.DEL_REQUEST;
038    
039        /** Delete response message type enumeration value */
040        MessageTypeEnum RESP_TYPE = InternalDeleteResponse.TYPE;
041    
042    
043        /**
044         * Gets the distinguished name of the leaf entry to be deleted by this
045         * request.
046         * 
047         * @return the DN of the leaf entry to delete.
048         */
049        DN getName();
050    
051    
052        /**
053         * Sets the distinguished name of the leaf entry to be deleted by this
054         * request.
055         * 
056         * @param name the DN of the leaf entry to delete.
057         */
058        void setName( DN name );
059    }