oracle.oud.requests

Interface DeleteRequest

All Superinterfaces:

AttachmentHolder, Request

All Known Implementing Classes:

DeleteRequestWrapper

public interface DeleteRequest
extends Request

The Delete operation allows to request the removal of an entry from the Directory.

Only leaf entries (those with no subordinate entries) can be deleted with this operation. However, addition of the SubtreeDeleteControl permits whole sub-trees to be deleted using a single Delete request.

Creation of Delete requests is provided by newDeleteRequest(DN) and newDeleteRequest(String)

Method Summary

Modifier and Type	Method and Description
DeleteRequest	addControl(Control control) Adds the provided control to this request.
DN	getName() Returns the distinguished name of the entry to be deleted.
DeleteRequest	setName(DN dn) Sets the distinguished name of the entry to be deleted.
DeleteRequest	setName(java.lang.String dn) Sets the distinguished name of the entry to be deleted.

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

addControl

DeleteRequest addControl(Control control)
                  throws java.lang.UnsupportedOperationException,
                         java.lang.NullPointerException

Adds the provided control to this request.

Specified by:

addControl in interface Request

Parameters:

control - The control to be added to this request.

Returns:

This request.

Throws:

java.lang.UnsupportedOperationException - If this request does not permit controls to be added.

java.lang.NullPointerException - If control was null.

getName

DN getName()

Returns the distinguished name of the entry to be deleted.

Returns:

The distinguished name of the entry.

setName

DeleteRequest setName(DN dn)
               throws java.lang.UnsupportedOperationException,
                      java.lang.NullPointerException

Sets the distinguished name of the entry to be deleted.

Parameters:

dn - The distinguished name of the entry to be deleted.

Returns:

This delete request.

Throws:

java.lang.UnsupportedOperationException - If this delete request does not permit the distinguished name to be set.

java.lang.NullPointerException - If dn was null.

setName

DeleteRequest setName(java.lang.String dn)
               throws PluginException,
                      java.lang.UnsupportedOperationException,
                      java.lang.NullPointerException

Sets the distinguished name of the entry to be deleted.

Parameters:

dn - The distinguished name of the entry to be deleted.

Returns:

This delete request.

Throws:

PluginException - If dn could not be decoded.

java.lang.UnsupportedOperationException - If this delete request does not permit the distinguished name to be set.

java.lang.NullPointerException - If dn was null.