org.apache.directory.api.ldap.extras.extended
Interface CancelRequest

All Superinterfaces:

org.apache.directory.api.ldap.model.message.ExtendedRequest<CancelResponse>, org.apache.directory.api.ldap.model.message.Message, org.apache.directory.api.ldap.model.message.Request, org.apache.directory.api.ldap.model.message.ResultResponseRequest<CancelResponse>, org.apache.directory.api.ldap.model.message.SingleReplyRequest<CancelResponse>

All Known Implementing Classes:

CancelRequestImpl

public interface CancelRequest
extends org.apache.directory.api.ldap.model.message.ExtendedRequest<CancelResponse>

The CancelRequest interface.

Author:

Apache Directory Project

Field Summary

static String

EXTENSION_OID The requestName for this extended request

Fields inherited from interface org.apache.directory.api.ldap.model.message.ExtendedRequest

RESP_TYPE, TYPE

Method Summary

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.SingleReplyRequest

getResponseType

Methods inherited from interface org.apache.directory.api.ldap.model.message.ResultResponseRequest

getResultResponse

Methods inherited from interface org.apache.directory.api.ldap.model.message.Request

hasResponse

Methods inherited from interface org.apache.directory.api.ldap.model.message.Message

get, getControl, getControls, getMessageId, getType, hasControl, put

Field Detail

EXTENSION_OID

static final String EXTENSION_OID

The requestName for this extended 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.