/*
|
* CDDL HEADER START
|
*
|
* The contents of this file are subject to the terms of the
|
* Common Development and Distribution License, Version 1.0 only
|
* (the "License"). You may not use this file except in compliance
|
* with the License.
|
*
|
* You can obtain a copy of the license at
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
|
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
|
* See the License for the specific language governing permissions
|
* and limitations under the License.
|
*
|
* When distributing Covered Code, include this CDDL HEADER in each
|
* file and include the License file at
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
|
* add the following below this CDDL HEADER, with the fields enclosed
|
* by brackets "[]" replaced with your own identifying information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Copyright 2009 Sun Microsystems, Inc.
|
*/
|
|
package org.opends.sdk.requests;
|
|
|
|
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.
|
* <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.
|
*/
|
public interface DeleteRequest extends Request, ChangeRecord
|
{
|
/**
|
* {@inheritDoc}
|
*/
|
<R, P> R accept(ChangeRecordVisitor<R, P> v, P p);
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
DeleteRequest addControl(Control control)
|
throws UnsupportedOperationException, NullPointerException;
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
<C extends Control> C getControl(ControlDecoder<C> decoder,
|
DecodeOptions options) throws NullPointerException, DecodeException;
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
List<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.
|
*
|
* @return The distinguished name of the entry.
|
*/
|
DN getName();
|
|
|
|
/**
|
* 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.
|
* @throws NullPointerException
|
* If {@code dn} was {@code null}.
|
*/
|
DeleteRequest setName(DN dn) 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.
|
*
|
* @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.
|
* @throws UnsupportedOperationException
|
* 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,
|
UnsupportedOperationException, NullPointerException;
|
|
}
|
