org.opends.server.types
Class ConfigChangeResult

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

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

This class defines a data structure that can be used to hold information about the result of processing a configuration change.


Constructor Summary
ConfigChangeResult(ResultCode resultCode, boolean adminActionRequired)
          Creates a new config change result object with the provided information.
ConfigChangeResult(ResultCode resultCode, boolean adminActionRequired, java.util.List<Message> messages)
          Creates a new config change result object with the provided information.
 
Method Summary
 void addMessage(Message message)
          Adds the provided message to the set of messages for this config change result.
 boolean adminActionRequired()
          Indicates whether administrative action is required before one or more of the changes will take effect.
 java.util.List<Message> getMessages()
          Retrieves the set of messages that provide explanation for the processing of the configuration changes.
 ResultCode getResultCode()
          Retrieves the result code for this config change result.
 void setAdminActionRequired(boolean adminActionRequired)
          Specifies whether administrative action is required before one or more of the changes will take effect.
 void setResultCode(ResultCode resultCode)
          Specifies the result code for this config change result.
 java.lang.String toString()
          Retrieves a string representation of this config change result.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this config change result to the provided buffer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ConfigChangeResult

public ConfigChangeResult(ResultCode resultCode,
                          boolean adminActionRequired)
Creates a new config change result object with the provided information.

Parameters:
resultCode - The result code for this config change result.
adminActionRequired - Indicates whether administrative action is required for one or more of the changes to take effect.

ConfigChangeResult

public ConfigChangeResult(ResultCode resultCode,
                          boolean adminActionRequired,
                          java.util.List<Message> messages)
Creates a new config change result object with the provided information.

Parameters:
resultCode - The result code for this config change result.
adminActionRequired - Indicates whether administrative action is required for one or more of the changes to take effect.
messages - A set of messages that provide additional information about the change processing.
Method Detail

getResultCode

public ResultCode getResultCode()
Retrieves the result code for this config change result.

Returns:
The result code for this config change result.

setResultCode

public void setResultCode(ResultCode resultCode)
Specifies the result code for this config change result.

Parameters:
resultCode - The result code for this config change result.

adminActionRequired

public boolean adminActionRequired()
Indicates whether administrative action is required before one or more of the changes will take effect.

Returns:
true if one or more of the configuration changes require administrative action to take effect, or false if not.

setAdminActionRequired

public void setAdminActionRequired(boolean adminActionRequired)
Specifies whether administrative action is required before one or more of the changes will take effect.

Parameters:
adminActionRequired - Specifies whether administrative action is required before one or more of the changes will take effect.

getMessages

public java.util.List<Message> getMessages()
Retrieves the set of messages that provide explanation for the processing of the configuration changes. This list may be modified by the caller.

Returns:
The set of messages that provide explanation for the processing of the configuration changes.

addMessage

public void addMessage(Message message)
Adds the provided message to the set of messages for this config change result.

Parameters:
message - The message to add to the set of messages for this config change result.

toString

public java.lang.String toString()
Retrieves a string representation of this config change result.

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

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this config change result to the provided buffer.

Parameters:
buffer - The buffer to which the information should be appended.