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