CancelRequest (org.apache.directory.api_api-all_sources-and-javadoc 2.1.1 API)

All Superinterfaces:

ExtendedRequest, Message, Request, ResultResponseRequest, SingleReplyRequest

All Known Implementing Classes:

CancelRequestImpl
```
public interface CancelRequest
extends ExtendedRequest
```
The CancelRequest interface, as described in RFC 3909 :
```
 cancelRequestValue ::= SEQUENCE {
        cancelID        MessageID
                        -- MessageID is as defined in [RFC2251]
 
```
Author:

Apache Directory Project

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static String EXTENSION_OID
  The OID for the Cancel extended operation request.
- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  int getCancelId()
  
  void setCancelId(int cancelId)
  Sets the message to cancel by id.
  - Methods inherited from interface org.apache.directory.api.ldap.model.message.ExtendedRequest
    addAllControls, addControl, getRequestName, removeControl, setMessageId, setRequestName
  - Methods inherited from interface org.apache.directory.api.ldap.model.message.Message
    get, getControl, getControls, getMessageId, getType, hasControl, put
  - Methods inherited from interface org.apache.directory.api.ldap.model.message.Request
    hasResponse
  - Methods inherited from interface org.apache.directory.api.ldap.model.message.ResultResponseRequest
    getResultResponse
  - Methods inherited from interface org.apache.directory.api.ldap.model.message.SingleReplyRequest
    getResponseType

- Field Detail
  - EXTENSION_OID
```
static final String EXTENSION_OID
```
    The OID for the Cancel extended operation request.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getCancelId
```
int getCancelId()
```
    Returns:
    
    The id of the Message to cancel.
  - setCancelId
```
void setCancelId(int cancelId)
```
    Sets the message to cancel by id.
    
    Parameters:
    
    cancelId - The id of the message to cancel.