Interface DeleteRequest
-
- All Superinterfaces:
AbandonableRequest
,Message
,Request
,ResultResponseRequest
,SingleReplyRequest
- All Known Implementing Classes:
DeleteRequestImpl
,DelRequestDsml
public interface DeleteRequest extends SingleReplyRequest, AbandonableRequest
Delete request protocol message used to remove an existing leaf entry from the directory.- Author:
- Apache Directory Project
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DeleteRequest
addAllControls(Control[] controls)
Adds an array of controls to this Message.DeleteRequest
addControl(Control control)
Adds a control to this Message.Dn
getName()
Gets the distinguished name of the leaf entry to be deleted by this request.DeleteRequest
removeControl(Control control)
Deletes a control removing it from this Message.DeleteRequest
setMessageId(int messageId)
Sets the Message ID for this requestDeleteRequest
setName(Dn name)
Sets the distinguished name of the leaf entry to be deleted by this request.-
Methods inherited from interface org.apache.directory.api.ldap.model.message.AbandonableRequest
abandon, addAbandonListener, isAbandoned
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Message
get, getControl, getControls, getMessageId, getType, hasControl, put
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Request
hasResponse
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.ResultResponseRequest
getResultResponse
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.SingleReplyRequest
getResponseType
-
-
-
-
Method Detail
-
getName
Dn getName()
Gets the distinguished name of the leaf entry to be deleted by this request.- Returns:
- the Dn of the leaf entry to delete.
-
setName
DeleteRequest setName(Dn name)
Sets the distinguished name of the leaf entry to be deleted by this request.- Parameters:
name
- the Dn of the leaf entry to delete.- Returns:
- The DeleteRequest instance
-
setMessageId
DeleteRequest setMessageId(int messageId)
Sets the Message ID for this request- Specified by:
setMessageId
in interfaceMessage
- Parameters:
messageId
- The message Id- Returns:
- A Message reference
-
addControl
DeleteRequest addControl(Control control)
Adds a control to this Message.- Specified by:
addControl
in interfaceMessage
- Parameters:
control
- the control to add.- Returns:
- A Message reference
-
addAllControls
DeleteRequest addAllControls(Control[] controls)
Adds an array of controls to this Message.- Specified by:
addAllControls
in interfaceMessage
- Parameters:
controls
- the controls to add.- Returns:
- A Message reference
-
removeControl
DeleteRequest removeControl(Control control)
Deletes a control removing it from this Message.- Specified by:
removeControl
in interfaceMessage
- Parameters:
control
- the control to remove.- Returns:
- A Message reference
-
-