org.forgerock.opendj.config.server

Class ConfigChangeResult

java.lang.Object

org.forgerock.opendj.config.server.ConfigChangeResult

public final class ConfigChangeResult
extends Object

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

Constructor Summary

Constructors

Constructor and Description
ConfigChangeResult() Creates a new config change result object with the provided information.

Method Summary

Modifier and Type	Method and Description
void	addMessage(LocalizableMessage 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.
void	aggregate(ConfigChangeResult other) Aggregates the results from the provided config change result.
LocalizableMessage	getJoinedMessages() Returns all messages joined in a single message.
List<LocalizableMessage>	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.
void	setResultCodeIfSuccess(ResultCode newResultCode) Sets the provided result code for this config change result if the current result code is success.
String	toString() Retrieves a string representation of this config change result.
void	toString(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()

Creates a new config change result object with the provided information.

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.

setResultCodeIfSuccess

public void setResultCodeIfSuccess(ResultCode newResultCode)

Sets the provided result code for this config change result if the current result code is success.

Parameters:

newResultCode - The new result code for this config change result.

aggregate

public void aggregate(ConfigChangeResult other)

Aggregates the results from the provided config change result.

Parameters:

other - The config change result to aggregate

getJoinedMessages

public LocalizableMessage getJoinedMessages()

Returns all messages joined in a single message.

Returns:

all messages joined in a single message

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 List<LocalizableMessage> 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(LocalizableMessage 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 String toString()

Retrieves a string representation of this config change result.

Overrides:

toString in class Object

Returns:

A string representation of this config change result.

toString

public void toString(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.