001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2006-2008 Sun Microsystems, Inc.
015 * Portions Copyright 2015 ForgeRock AS.
016 */
017package org.opends.server.tools;
018
019
020
021
022/**
023 * This class defines options for all the delete operations used
024 * by the ldapdelete tool.
025 */
026public class LDAPDeleteOptions extends LDAPToolOptions
027{
028
029  private boolean deleteSubtree;
030
031  /**
032   * Creates the options instance.
033   *
034   */
035  public LDAPDeleteOptions()
036  {
037  }
038
039  /**
040   * Set whether to delete the entire subtree or not.
041   *
042   * @param  deleteSubtree  Indicates whether to delete the entire subtree.
043   */
044  public void setDeleteSubtree(boolean deleteSubtree)
045  {
046    this.deleteSubtree = deleteSubtree;
047  }
048
049  /**
050   * Get the value of the deleteSubtree flag.
051   *
052   * @return  <CODE>true</CODE> if the subtree delete control should be
053   *          included in the request, or <CODE>false</CODE> if not.
054   */
055  public boolean getDeleteSubtree()
056  {
057    return deleteSubtree;
058  }
059}
060