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