public final class ConfigChangeResult extends Object
Constructor and Description |
---|
ConfigChangeResult()
Creates a new config change result object with the provided information.
|
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.
|
public ConfigChangeResult()
public ResultCode getResultCode()
public void setResultCode(ResultCode resultCode)
resultCode
- The result code for this config change result.public void setResultCodeIfSuccess(ResultCode newResultCode)
newResultCode
- The new result code for this config change result.public void aggregate(ConfigChangeResult other)
other
- The config change result to aggregatepublic LocalizableMessage getJoinedMessages()
public boolean adminActionRequired()
true
if one or more of the configuration changes
require administrative action to take effect, or
false
if not.public void setAdminActionRequired(boolean adminActionRequired)
adminActionRequired
- Specifies whether administrative action is required before one
or more of the changes will take effect.public List<LocalizableMessage> getMessages()
public void addMessage(LocalizableMessage message)
message
- The message to add to the set of messages for this config
change result.public String toString()
public void toString(StringBuilder buffer)
buffer
- The buffer to which the information should be appended.Copyright 2010-2022 ForgeRock AS.