Package org.opends.server.types

Class CancelRequest

java.lang.Object

org.opends.server.types.CancelRequest

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public final class CancelRequest
extends Object

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, org.forgerock.i18n.LocalizableMessage cancelReason)	Creates a new cancel request with the provided information.

Method Summary

Modifier and Type	Method	Description
org.forgerock.i18n.LocalizableMessage	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

CancelRequest

public CancelRequest(boolean notifyOriginalRequestor,
                     org.forgerock.i18n.LocalizableMessage cancelReason)

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()

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, or false if not.

getCancelReason

public org.forgerock.i18n.LocalizableMessage getCancelReason()

Retrieves a message that explains the purpose for this cancellation.

Returns:

A message that explains the purpose for this cancellation.