com.unboundid.ldap.sdk.unboundidds
Class MoveSubtreeResult

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.MoveSubtreeResult
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class MoveSubtreeResult
extends java.lang.Object
implements java.io.Serializable

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.

See Also:
Serialized Form

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

getResultCode

public ResultCode getResultCode()
Retrieves a result code which indicates the ultimate state of the move subtree processing. A result of 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.

Returns:
A result code which indicates the ultimate state of the move subtree processing.

getErrorMessage

public java.lang.String getErrorMessage()
Retrieves an error message with information about a problem that occurred during processing, if any.

Returns:
An error message with information about a problem that occurred during processing, or null if no errors were encountered.

getAdminActionRequired

public 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.

Returns:
A message with information about any administrative action which may be required to bring the data in the servers back into a consistent state, or null if no administrative action is necessary.

sourceServerAltered

public boolean sourceServerAltered()
Indicates whether any data in the source server has been altered as a result of the processing performed during the subtree move. A successful subtree move will cause entries to be removed from the source server, but there may be error conditions which also result in source server changes.

Returns:
true if any data in the source server has been altered as a result of the processing performed, or false if not.

targetServerAltered

public boolean targetServerAltered()
Indicates whether any data in the target server has been altered as a result of the processing performed during the subtree move. A successful subtree move will cause entries to be added to the target server, but there may be error conditions which also result in target server changes.

Returns:
true if any data in the target server has been altered as a result of the processing performed, or false if not.

getEntriesReadFromSource

public int getEntriesReadFromSource()
Retrieves the number of entries within the specified subtree read from the source server.

Returns:
The number of entries within the specified subtree read from the source server.

getEntriesAddedToTarget

public int getEntriesAddedToTarget()
Retrieves the number of entries added to the target server as a result of the subtree move. Note that even in a completely successful subtree move, it is possible for this number to be less than the number of entries read from the source server if a 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.

Returns:
The number of entries added to the target server as a result of the subtree move.

getEntriesDeletedFromSource

public int getEntriesDeletedFromSource()
Retrieves the number of entries deleted from the source server as a result of the subtree move. If all processing is successful, then this value should match the number of entries read from the source server.

Returns:
The number of entries deleted from the target server as a result of the subtree move.

toString

public java.lang.String toString()
Retrieves a string representation of this move subtree result object.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this move subtree result object.

toString

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

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