org.opends.server.types
Class CancelResult

java.lang.Object
  extended by org.opends.server.types.CancelResult

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public class CancelResult
extends java.lang.Object

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
CancelResult(ResultCode resultCode, Message responseMessage)
          Creates a new cancel result with the provided result code.
 
Method Summary
 Message getResponseMessage()
          Retrieves the human-readable response that the server provided for the result of the cancellation.
 ResultCode getResultCode()
          Retrieves the result code associated with this cancel result.
 java.lang.String toString()
          Retrieves a string representation of this cancel result.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CancelResult

public CancelResult(ResultCode resultCode,
                    Message responseMessage)
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()
Retrieves the result code associated with this cancel result.

Returns:
The result code associated with this cancel result.

getResponseMessage

public Message getResponseMessage()
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.

toString

public final java.lang.String toString()
Retrieves a string representation of this cancel result.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this cancel result.