Package org.opends.server.types
Class CancelRequest
- java.lang.Object
-
- org.opends.server.types.CancelRequest
-
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) @Deprecated public final class CancelRequest extends Object
Deprecated.This class defines a data structure that can be used to hold information about a request to cancel or abandon an operation in progress.
-
-
Constructor Summary
Constructors Constructor Description CancelRequest(boolean notifyOriginalRequestor, LocalizableMessage cancelReason)
Deprecated.Creates a new cancel request with the provided information.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description LocalizableMessage
getCancelReason()
Deprecated.Retrieves a message that explains the purpose for this cancellation.boolean
notifyOriginalRequestor()
Deprecated.Indicates whether the original requestor should receive a response to the request if the operation is canceled.
-
-
-
Constructor Detail
-
CancelRequest
public CancelRequest(boolean notifyOriginalRequestor, LocalizableMessage cancelReason)
Deprecated.Creates a new cancel request with the provided information.- Parameters:
notifyOriginalRequestor
- Indicates whether the original requestor should receive a response if the operation is canceled.cancelReason
- A message that explains the purpose for this cancellation.
-
-
Method Detail
-
notifyOriginalRequestor
public boolean notifyOriginalRequestor()
Deprecated.Indicates whether the original requestor should receive a response to the request if the operation is canceled.- Returns:
true
if the original requestor should receive a response if the operation is canceled, orfalse
if not.
-
getCancelReason
public LocalizableMessage getCancelReason()
Deprecated.Retrieves a message that explains the purpose for this cancellation.- Returns:
- A message that explains the purpose for this cancellation.
-
-