View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *  
10   *    https://www.apache.org/licenses/LICENSE-2.0
11   *  
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License. 
18   *  
19   */
20  package org.apache.directory.api.ldap.model.message;
21  
22  
23  import org.apache.directory.api.ldap.model.name.Dn;
24  
25  
26  /**
27   * Delete request protocol message used to remove an existing leaf entry from
28   * the directory.
29   * 
30   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31   */
32  public interface DeleteRequest extends SingleReplyRequest, AbandonableRequest
33  {
34      /**
35       * Gets the distinguished name of the leaf entry to be deleted by this
36       * request.
37       * 
38       * @return the Dn of the leaf entry to delete.
39       */
40      Dn getName();
41  
42  
43      /**
44       * Sets the distinguished name of the leaf entry to be deleted by this
45       * request.
46       * 
47       * @param name the Dn of the leaf entry to delete.
48       * @return The DeleteRequest instance
49       */
50      DeleteRequest setName( Dn name );
51  
52  
53      /**
54       * {@inheritDoc}
55       */
56      @Override
57      DeleteRequest setMessageId( int messageId );
58  
59  
60      /**
61       * {@inheritDoc}
62       */
63      @Override
64      DeleteRequest addControl( Control control );
65  
66  
67      /**
68       * {@inheritDoc}
69       */
70      @Override
71      DeleteRequest addAllControls( Control[] controls );
72  
73  
74      /**
75       * {@inheritDoc}
76       */
77      @Override
78      DeleteRequest removeControl( Control control );
79  }