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   *    http://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.extras.extended.cancel;
21  
22  
23  import org.apache.directory.api.ldap.model.message.ExtendedRequest;
24  
25  
26  /**
27   * The CancelRequest interface.
28   *
29   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
30   */
31  public interface CancelRequest extends ExtendedRequest
32  {
33      /** The OID for the Cancel extended operation request. */
34      static final String EXTENSION_OID = "1.3.6.1.1.8";
35  
36  
37      /**
38       *  @return The id of the Message to cancel.
39       */
40      int getCancelId();
41  
42  
43      /**
44       * Sets the message to cancel by id.
45       *
46       * @param cancelId The id of the message to cancel.
47       */
48      void setCancelId( int cancelId );
49  }