|
Oracle® Fusion Middleware Java API Reference for Oracle Unified Directory 11g Release 2 (11.1.2.2.0) E38583-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ModifyDNRequest
The Modify DN operation allows a client to change the Relative Distinguished Name (RDN) of an entry in the Directory and/or to move a subtree of entries to a new location in the Directory.
Creation of Modify DN requests is provided by newModifyDNRequest(DN, RDN)
and newModifyDNRequest(String, String)
Method Summary | |
---|---|
ModifyDNRequest |
addControl(Control control) Adds the provided control to this request. |
DN |
getName() Returns the distinguished name of the entry to be renamed. |
RDN |
getNewRDN() Returns the new RDN of the entry to be renamed. |
DN |
getNewSuperior() Returns the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed. |
boolean |
isDeleteOldRDN() Indicates whether the old RDN attribute values are to be retained as attributes of the entry or deleted from the entry. |
ModifyDNRequest |
setDeleteOldRDN(boolean deleteOldRDN) Specifies whether the old RDN attribute values are to be retained as attributes of the entry or deleted from the entry. |
ModifyDNRequest |
setName(DN dn) Sets the distinguished name of the entry to be renamed. |
ModifyDNRequest |
setName(java.lang.String dn) Sets the distinguished name of the entry to be renamed. |
ModifyDNRequest |
setNewRDN(RDN rdn) Sets the new RDN of the entry to be renamed. |
ModifyDNRequest |
setNewRDN(java.lang.String rdn) Sets the new RDN of the entry to be renamed. |
ModifyDNRequest |
setNewSuperior(DN dn) Sets the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed. |
ModifyDNRequest |
setNewSuperior(java.lang.String dn) Sets the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed. |
Methods inherited from interface oracle.oud.requests.Request |
---|
getControl, getControls, isInternal, removeControl |
Methods inherited from interface oracle.oud.plugin.AttachmentHolder |
---|
getAttachment, getAttachmentNames, removeAttachment, setAttachment |
Method Detail |
---|
ModifyDNRequest addControl(Control control) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
addControl
in interface Request
control
- The control to be added to this request.java.lang.UnsupportedOperationException
- If this request does not permit controls to be added.java.lang.NullPointerException
- If control
was null
.DN getName()
RDN getNewRDN()
DN getNewSuperior()
null
if the entry is to remain under the same parent entry.boolean isDeleteOldRDN()
true
if the old RDN attribute values are to be deleted from the entry, or false
if they are to be retained.ModifyDNRequest setDeleteOldRDN(boolean deleteOldRDN) throws java.lang.UnsupportedOperationException
deleteOldRDN
- true
if the old RDN attribute values are to be deleted from the entry, or false
if they are to be retained.java.lang.UnsupportedOperationException
- If this modify DN request does not permit the delete old RDN parameter to be set.ModifyDNRequest setName(DN dn) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
dn
- The distinguished name of the entry to be renamed.java.lang.UnsupportedOperationException
- If this modify DN request does not permit the distinguished name to be set.java.lang.NullPointerException
- If dn
was null
.ModifyDNRequest setName(java.lang.String dn) throws PluginException, java.lang.UnsupportedOperationException, java.lang.NullPointerException
dn
- The distinguished name of the entry to be renamed.PluginException
- If dn
could not be decoded.java.lang.UnsupportedOperationException
- If this modify DN request does not permit the distinguished name to be set.java.lang.NullPointerException
- If dn
was null
.ModifyDNRequest setNewRDN(RDN rdn) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
rdn
- The new RDN of the entry to be renamed.java.lang.UnsupportedOperationException
- If this modify DN request does not permit the new RDN to be set.java.lang.NullPointerException
- If rdn
was null
.ModifyDNRequest setNewRDN(java.lang.String rdn) throws PluginException, java.lang.UnsupportedOperationException, java.lang.NullPointerException
rdn
- The new RDN of the entry to be renamed.PluginException
- If rdn
could not be decoded.java.lang.UnsupportedOperationException
- If this modify DN request does not permit the new RDN to be set.java.lang.NullPointerException
- If rdn
was null
.ModifyDNRequest setNewSuperior(DN dn) throws java.lang.UnsupportedOperationException
dn
- The distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed, may be null
.java.lang.UnsupportedOperationException
- If this modify DN request does not permit the new superior to be set.ModifyDNRequest setNewSuperior(java.lang.String dn) throws PluginException, java.lang.UnsupportedOperationException
dn
- The distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed, may be null
.PluginException
- If dn
could not be decoded.java.lang.UnsupportedOperationException
- If this modify DN request does not permit the new superior to be set.
|
Oracle® Fusion Middleware Java API Reference for Oracle Unified Directory 11g Release 2 (11.1.2.2.0) E38583-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |