|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.MoveSubtreeResult
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class MoveSubtreeResult
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class provides a data structure that holds information about the result of a move subtree operation.
Method Summary | |
---|---|
java.lang.String |
getAdminActionRequired()
Retrieves a message with information about any administrative action which may be required to bring data in the servers back into a consistent state so that the entries in the target subtree will only exist in one of the two servers. |
int |
getEntriesAddedToTarget()
Retrieves the number of entries added to the target server as a result of the subtree move. |
int |
getEntriesDeletedFromSource()
Retrieves the number of entries deleted from the source server as a result of the subtree move. |
int |
getEntriesReadFromSource()
Retrieves the number of entries within the specified subtree read from the source server. |
java.lang.String |
getErrorMessage()
Retrieves an error message with information about a problem that occurred during processing, if any. |
ResultCode |
getResultCode()
Retrieves a result code which indicates the ultimate state of the move subtree processing. |
boolean |
sourceServerAltered()
Indicates whether any data in the source server has been altered as a result of the processing performed during the subtree move. |
boolean |
targetServerAltered()
Indicates whether any data in the target server has been altered as a result of the processing performed during the subtree move. |
java.lang.String |
toString()
Retrieves a string representation of this move subtree result object. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this move subtree result object to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public ResultCode getResultCode()
SUCCESS
indicates that all
processing was successful and the subtree was moved from one server to
another. Any other result indicates that some kind of error occurred.
public java.lang.String getErrorMessage()
null
if no errors were encountered.public java.lang.String getAdminActionRequired()
null
if no administrative action is
necessary.public boolean sourceServerAltered()
true
if any data in the source server has been altered as
a result of the processing performed, or false
if not.public boolean targetServerAltered()
true
if any data in the target server has been altered as
a result of the processing performed, or false
if not.public int getEntriesReadFromSource()
public int getEntriesAddedToTarget()
MoveSubtreeListener
is in use and its
doPreAddProcessing
method returns null for one or more entries to
indicate that those entries should not be added to the target.
public int getEntriesDeletedFromSource()
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 |