|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.CancelRequest
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class CancelRequest
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 | |
---|---|
CancelRequest(boolean notifyOriginalRequestor,
Message cancelReason)
Creates a new cancel request with the provided information. |
Method Summary | |
---|---|
Message |
getCancelReason()
Retrieves a message that explains the purpose for this cancellation. |
boolean |
notifyOriginalRequestor()
Indicates whether the original requestor should receive a response to the request if the operation is canceled. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CancelRequest(boolean notifyOriginalRequestor, Message cancelReason)
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 |
---|
public boolean notifyOriginalRequestor()
true
if the original requestor should
receive a response if the operation is canceled, or
false
if not.public Message getCancelReason()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |