/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions Copyright [year] [name of copyright owner]".
 *
 * Copyright 2006-2008 Sun Microsystems, Inc.
 * Portions Copyright 2015 ForgeRock AS.
 */
package org.opends.server.tools;




/**
 * This class defines options for all the delete operations used
 * by the ldapdelete tool.
 */
public class LDAPDeleteOptions extends LDAPToolOptions
{

  private boolean deleteSubtree;

  /**
   * Creates the options instance.
   *
   */
  public LDAPDeleteOptions()
  {
  }

  /**
   * Set whether to delete the entire subtree or not.
   *
   * @param  deleteSubtree  Indicates whether to delete the entire subtree.
   */
  public void setDeleteSubtree(boolean deleteSubtree)
  {
    this.deleteSubtree = deleteSubtree;
  }

  /**
   * Get the value of the deleteSubtree flag.
   *
   * @return  <CODE>true</CODE> if the subtree delete control should be
   *          included in the request, or <CODE>false</CODE> if not.
   */
  public boolean getDeleteSubtree()
  {
    return deleteSubtree;
  }
}