Package org.opends.server.types
Class CancelResult
- java.lang.Object
-
- org.opends.server.types.CancelResult
-
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) @Deprecated public class CancelResult extends Object
Deprecated.This enumeration defines the set of possible outcomes that can result from processing a cancel request. This is based on the specification contained in RFC 3909.
-
-
Constructor Summary
Constructors Constructor Description CancelResult(ResultCode resultCode, LocalizableMessage responseMessage)
Deprecated.Creates a new cancel result with the provided result code.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description LocalizableMessage
getResponseMessage()
Deprecated.Retrieves the human-readable response that the server provided for the result of the cancellation.ResultCode
getResultCode()
Deprecated.Retrieves the result code associated with this cancel result.String
toString()
Deprecated.Retrieves a string representation of this cancel result.
-
-
-
Constructor Detail
-
CancelResult
public CancelResult(ResultCode resultCode, LocalizableMessage responseMessage)
Deprecated.Creates a new cancel result with the provided result code.- Parameters:
resultCode
- The result code associated with this cancel result.responseMessage
- A human-readable response that the server provided for the result of the cancellation.
-
-
Method Detail
-
getResultCode
public final ResultCode getResultCode()
Deprecated.Retrieves the result code associated with this cancel result.- Returns:
- The result code associated with this cancel result.
-
getResponseMessage
public LocalizableMessage getResponseMessage()
Deprecated.Retrieves the human-readable response that the server provided for the result of the cancellation. The caller may alter the contents of this buffer.- Returns:
- The buffer that is used to hold a human-readable response that the server provided for the result of this cancellation.
-
-