org.opends.server.util
Class ModifyDNChangeRecordEntry

java.lang.Object
  extended by org.opends.server.util.ChangeRecordEntry
      extended by org.opends.server.util.ModifyDNChangeRecordEntry

@PublicAPI(stability=VOLATILE,
           mayInstantiate=true,
           mayExtend=false,
           mayInvoke=true)
public final class ModifyDNChangeRecordEntry
extends ChangeRecordEntry

This class defines a data structure for a change record entry for an modifyDN operation. It includes a DN and a set of attributes, as well as methods to decode the entry.


Constructor Summary
ModifyDNChangeRecordEntry(DN dn, RDN newRDN, boolean deleteOldRDN, DN newSuperiorDN)
          Creates a new entry with the provided information.
 
Method Summary
 boolean deleteOldRDN()
          Get the new RDN for the requested modify DN operation.
 ChangeOperationType getChangeOperationType()
          Retrieves the name of the change operation type.
 RDN getNewRDN()
          Get the new RDN for the requested modify DN operation.
 DN getNewSuperiorDN()
          Get the new superior DN for the requested modify DN operation.
 java.lang.String toString()
          Retrieves a string representation of this change record entry.
 
Methods inherited from class org.opends.server.util.ChangeRecordEntry
getDN
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ModifyDNChangeRecordEntry

public ModifyDNChangeRecordEntry(DN dn,
                                 RDN newRDN,
                                 boolean deleteOldRDN,
                                 DN newSuperiorDN)
Creates a new entry with the provided information.

Parameters:
dn - The distinguished name for this entry. It must not be null.
newRDN - The new RDN. It must not be null.
deleteOldRDN - Delete the old RDN?
newSuperiorDN - The new superior DN. It may be null if the entry is not to be moved below a new parent.
Method Detail

getNewRDN

public RDN getNewRDN()
Get the new RDN for the requested modify DN operation.

Returns:
the new RDN.

getNewSuperiorDN

public DN getNewSuperiorDN()
Get the new superior DN for the requested modify DN operation.

Returns:
the new superior DN, or null if there is none.

deleteOldRDN

public boolean deleteOldRDN()
Get the new RDN for the requested modify DN operation.

Returns:
the new RDN.

getChangeOperationType

public ChangeOperationType getChangeOperationType()
Retrieves the name of the change operation type.

Specified by:
getChangeOperationType in class ChangeRecordEntry
Returns:
The name of the change operation type.

toString

public java.lang.String toString()
Retrieves a string representation of this change record entry.

Specified by:
toString in class ChangeRecordEntry
Returns:
A string representation of this change record entry.