|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.ConfigChangeResult
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=true, mayExtend=false, mayInvoke=true) public final class ConfigChangeResult
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 |
---|
public ConfigChangeResult(ResultCode resultCode, boolean adminActionRequired)
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.public ConfigChangeResult(ResultCode resultCode, boolean adminActionRequired, java.util.List<Message> messages)
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 |
---|
public ResultCode getResultCode()
public void setResultCode(ResultCode resultCode)
resultCode
- The result code for this config change
result.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 java.util.List<Message> getMessages()
public void addMessage(Message message)
message
- The message to add to the set of messages for
this config change result.public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the information should be
appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |