| | |
| | | |
| | | |
| | | |
| | | import java.util.List; |
| | | |
| | | import org.opends.sdk.DN; |
| | | import org.opends.sdk.DecodeException; |
| | | import org.opends.sdk.DecodeOptions; |
| | | import org.opends.sdk.LocalizedIllegalArgumentException; |
| | | import org.opends.sdk.controls.Control; |
| | | import org.opends.sdk.controls.ControlDecoder; |
| | | import org.opends.sdk.ldif.ChangeRecord; |
| | | import org.opends.sdk.ldif.ChangeRecordVisitor; |
| | | |
| | | |
| | | |
| | | |
| | | /** |
| | | * The Delete operation allows a client to request the removal of an |
| | | * entry from the Directory. |
| | | * The Delete operation allows a client to request the removal of an entry from |
| | | * the Directory. |
| | | * <p> |
| | | * Only leaf entries (those with no subordinate entries) can be deleted |
| | | * with this operation. However, addition of the {@code |
| | | * SubtreeDeleteControl} permits whole sub-trees to be deleted using a |
| | | * single Delete request. |
| | | * Only leaf entries (those with no subordinate entries) can be deleted with |
| | | * this operation. However, addition of the {@code SubtreeDeleteControl} permits |
| | | * whole sub-trees to be deleted using a single Delete request. |
| | | */ |
| | | public interface DeleteRequest extends Request, ChangeRecord |
| | | { |
| | |
| | | |
| | | |
| | | /** |
| | | * Adds the provided control to this request. |
| | | * |
| | | * @param control |
| | | * The control to be added to this request. |
| | | * @return This request. |
| | | * @throws UnsupportedOperationException |
| | | * If this request does not permit controls to be added. |
| | | * @throws NullPointerException |
| | | * If {@code control} was {@code null}. |
| | | * {@inheritDoc} |
| | | */ |
| | | DeleteRequest addControl(Control control) |
| | | throws UnsupportedOperationException, NullPointerException; |
| | |
| | | |
| | | |
| | | /** |
| | | * Removes all the controls included with this request. |
| | | * |
| | | * @return This request. |
| | | * @throws UnsupportedOperationException |
| | | * If this request does not permit controls to be removed. |
| | | * {@inheritDoc} |
| | | */ |
| | | DeleteRequest clearControls() throws UnsupportedOperationException; |
| | | <C extends Control> C getControl(ControlDecoder<C> decoder, |
| | | DecodeOptions options) throws NullPointerException, DecodeException; |
| | | |
| | | |
| | | |
| | | /** |
| | | * Returns the first control contained in this request having the |
| | | * specified OID. |
| | | * |
| | | * @param oid |
| | | * The OID of the control to be returned. |
| | | * @return The control, or {@code null} if the control is not included |
| | | * with this request. |
| | | * @throws NullPointerException |
| | | * If {@code oid} was {@code null}. |
| | | * {@inheritDoc} |
| | | */ |
| | | Control getControl(String oid) throws NullPointerException; |
| | | List<Control> getControls(); |
| | | |
| | | |
| | | |
| | | /** |
| | | * Returns an {@code Iterable} containing the controls included with |
| | | * this request. The returned {@code Iterable} may be used to remove |
| | | * controls if permitted by this request. |
| | | * |
| | | * @return An {@code Iterable} containing the controls. |
| | | */ |
| | | Iterable<Control> getControls(); |
| | | |
| | | |
| | | |
| | | /** |
| | | * Returns the distinguished name of the entry to be deleted. The |
| | | * server shall not dereference any aliases in locating the entry to |
| | | * be deleted. |
| | | * |
| | | * Returns the distinguished name of the entry to be deleted. The server shall |
| | | * not dereference any aliases in locating the entry to be deleted. |
| | | * |
| | | * @return The distinguished name of the entry. |
| | | */ |
| | | DN getName(); |
| | |
| | | |
| | | |
| | | /** |
| | | * Indicates whether or not this request has any controls. |
| | | * |
| | | * @return {@code true} if this request has any controls, otherwise |
| | | * {@code false}. |
| | | */ |
| | | boolean hasControls(); |
| | | |
| | | |
| | | |
| | | /** |
| | | * Removes the first control contained in this request having the |
| | | * specified OID. |
| | | * |
| | | * @param oid |
| | | * The OID of the control to be removed. |
| | | * @return The removed control, or {@code null} if the control is not |
| | | * included with this request. |
| | | * @throws UnsupportedOperationException |
| | | * If this request does not permit controls to be removed. |
| | | * @throws NullPointerException |
| | | * If {@code oid} was {@code null}. |
| | | */ |
| | | Control removeControl(String oid) |
| | | throws UnsupportedOperationException, NullPointerException; |
| | | |
| | | |
| | | |
| | | /** |
| | | * Sets the distinguished name of the entry to be deleted. The server |
| | | * shall not dereference any aliases in locating the entry to be |
| | | * deleted. |
| | | * |
| | | * Sets the distinguished name of the entry to be deleted. The server shall |
| | | * not dereference any aliases in locating the entry to be deleted. |
| | | * |
| | | * @param dn |
| | | * The distinguished name of the entry to be deleted. |
| | | * @return This delete request. |
| | | * @throws UnsupportedOperationException |
| | | * If this delete request does not permit the distinguished |
| | | * name to be set. |
| | | * If this delete request does not permit the distinguished name to |
| | | * be set. |
| | | * @throws NullPointerException |
| | | * If {@code dn} was {@code null}. |
| | | */ |
| | |
| | | |
| | | |
| | | /** |
| | | * Sets the distinguished name of the entry to be deleted. The server |
| | | * shall not dereference any aliases in locating the entry to be |
| | | * deleted. |
| | | * |
| | | * Sets the distinguished name of the entry to be deleted. The server shall |
| | | * not dereference any aliases in locating the entry to be deleted. |
| | | * |
| | | * @param dn |
| | | * The distinguished name of the entry to be deleted. |
| | | * @return This delete request. |
| | | * @throws LocalizedIllegalArgumentException |
| | | * If {@code dn} could not be decoded using the default |
| | | * schema. |
| | | * If {@code dn} could not be decoded using the default schema. |
| | | * @throws UnsupportedOperationException |
| | | * If this delete request does not permit the distinguished |
| | | * name to be set. |
| | | * If this delete request does not permit the distinguished name to |
| | | * be set. |
| | | * @throws NullPointerException |
| | | * If {@code dn} was {@code null}. |
| | | */ |
| | | DeleteRequest setName(String dn) |
| | | throws LocalizedIllegalArgumentException, |
| | | DeleteRequest setName(String dn) throws LocalizedIllegalArgumentException, |
| | | UnsupportedOperationException, NullPointerException; |
| | | |
| | | } |