mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

Matthew Swift
25.33.2012 263d085885df024dca9250cc03c807912b0a7662
opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/requests/DeleteRequest.java
@@ -6,17 +6,16 @@
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at
 * trunk/opendj3/legal-notices/CDDLv1_0.txt
 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
 * or http://forgerock.org/license/CDDLv1.0.html.
 * 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/opendj3/legal-notices/CDDLv1_0.txt.  If applicable,
 * add the following below this CDDL HEADER, with the fields enclosed
 * by brackets "[]" replaced with your own identifying information:
 * file and include the License file at legal-notices/CDDLv1_0.txt.
 * 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
@@ -28,11 +27,9 @@
package org.forgerock.opendj.ldap.requests;
import java.util.List;
import org.forgerock.i18n.*;
import org.forgerock.i18n.LocalizedIllegalArgumentException;
import org.forgerock.opendj.ldap.DN;
import org.forgerock.opendj.ldap.DecodeException;
import org.forgerock.opendj.ldap.DecodeOptions;
@@ -41,8 +38,6 @@
import org.forgerock.opendj.ldif.ChangeRecord;
import org.forgerock.opendj.ldif.ChangeRecordVisitor;
/**
 * The Delete operation allows a client to request the removal of an entry from
 * the Directory.
@@ -51,79 +46,66 @@
 * 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);
public interface DeleteRequest extends Request, ChangeRecord {
    /**
     * {@inheritDoc}
     */
    <R, P> R accept(ChangeRecordVisitor<R, P> v, P p);
    /**
     * {@inheritDoc}
     */
    DeleteRequest addControl(Control control);
    /**
     * {@inheritDoc}
     */
    <C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options)
            throws DecodeException;
  /**
   * {@inheritDoc}
   */
  DeleteRequest addControl(Control control);
    /**
     * {@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);
  /**
   * {@inheritDoc}
   */
  <C extends Control> C getControl(ControlDecoder<C> decoder,
      DecodeOptions options) throws 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);
  /**
   * 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);
    /**
     * 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);
}