com.unboundid.directory.sdk.common.operation

Interface ModifyDNRequest

All Superinterfaces:

ChangeRequest, Request

All Known Subinterfaces:

UpdatableModifyDNRequest

@NotExtensible
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface ModifyDNRequest
extends ChangeRequest

This interface defines a set of methods which may be used to interact with a modify DN request.

Method Summary

Modifier and Type	Method and Description
boolean	deleteOldRDN() Indicates whether to remove the old RDN values from the entry.
java.lang.String	getDN() Retrieves the DN of the entry to move and/or rename.
java.lang.String	getNewRDN() Retrieves the new RDN to use for the entry.
java.lang.String	getNewSuperiorDN() Retrieves the DN for the new superior entry, if any.
ReadOnlyModifyDNRequest	toLDAPSDKRequest() Retrieves an LDAP SDK representation of this modify DN request.
LDIFModifyDNChangeRecord	toLDIFChangeRecord() Retrieves an LDIF change record that corresponds to this modify DN request.

Methods inherited from interface com.unboundid.directory.sdk.common.operation.Request

getOperationType, getRequestControls

Method Detail

getDN

java.lang.String getDN()

Retrieves the DN of the entry to move and/or rename.

Returns:

The DN of the entry to move and/or rename.

getNewRDN

java.lang.String getNewRDN()

Retrieves the new RDN to use for the entry.

Returns:

The new RDN to use for the entry.

deleteOldRDN

boolean deleteOldRDN()

Indicates whether to remove the old RDN values from the entry.

Returns:

true if the old RDN values should be removed, or false if not.

getNewSuperiorDN

java.lang.String getNewSuperiorDN()

Retrieves the DN for the new superior entry, if any.

Returns:

The DN for the new superior entry, or null if the entry should remain below its current parent.

toLDAPSDKRequest

ReadOnlyModifyDNRequest toLDAPSDKRequest()

Retrieves an LDAP SDK representation of this modify DN request.

Returns:

An LDAP SDK representation of this modify DN request.

toLDIFChangeRecord

LDIFModifyDNChangeRecord toLDIFChangeRecord()

Retrieves an LDIF change record that corresponds to this modify DN request.

Specified by:

toLDIFChangeRecord in interface ChangeRequest

Returns:

An LDIF change record that corresponds to this modify DN request.