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<DeleteResponse>, AbandonableRequest
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 = DeleteResponse.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    Dn 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     * @return The DeleteRequest instance
056     */
057    DeleteRequest setName( Dn name );
058
059
060    /**
061     * {@inheritDoc}
062     */
063    DeleteRequest setMessageId( int messageId );
064
065
066    /**
067     * {@inheritDoc}
068     */
069    DeleteRequest addControl( Control control );
070
071
072    /**
073     * {@inheritDoc}
074     */
075    DeleteRequest addAllControls( Control[] controls );
076
077
078    /**
079     * {@inheritDoc}
080     */
081    DeleteRequest removeControl( Control control );
082}