cvs commit: jakarta-slide/src/webdav/client/src/org/apache/webdav/lib/methods DepthMethod.java

[bc...@locus.apache.org]

bcholmes    00/11/26 22:41:51

  Added:       src/webdav/client/src/org/apache/webdav/lib/methods
                        DepthMethod.java
  Log:
  - Implement Lock and Unlock methods
    (oops.  Missed an Add)
  
  Revision  Changes    Path
  1.1                  jakarta-slide/src/webdav/client/src/org/apache/webdav/lib/methods/DepthMethod.java
  
  Index: DepthMethod.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-slide/src/webdav/client/src/org/apache/webdav/lib/methods/DepthMethod.java,v 1.1 2000/11/27 06:41:50 bcholmes Exp $
   * $Revision: 1.1 $
   * $Date: 2000/11/27 06:41:50 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999 The Apache Software Foundation.  All rights 
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer. 
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:  
   *       "This product includes software developed by the 
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written 
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   * [Additional notices, if required by prior licensing conditions]
   *
   */ 
  
  package org.apache.webdav.lib.methods;
  
  /**
   * Methods that can act on collections (for example, DELETE, LOCK, PROPFIND, 
   * etc.) support a depth header.  The depth header indicates that the 
   * method applies to either:
   * <ol>
   * <li>the collection (depth 0);
   * <li>the collection and its immediate contents (depth 1); or
   * <li>the collection, its contents and all subcollections (depth infinity).
   * 
   * @author <a href="mailto:bcholmes@interlog.com">B.C. Holmes</a>
   */
  public interface DepthMethod {
      
      
      // -------------------------------------------------------------- Constants
      
      
      /**
       * Request with depth infinity.
       */
      public static final int DEPTH_INFINITY = -1;
      
      
      /**
       * Request with depth 0.
       */
      public static final int DEPTH_0 = 0;
      
      
      /**
       * Request with depth 1.
       */
      public static final int DEPTH_1 = 1;
  
      // ------------------------------------------------------------- Properties
      
      
      /**
       * Depth setter.
       * 
       * @param depth New depth value
       */
      public void setDepth(int depth);
      
      
      /**
       * Depth getter.
       * 
       * @return int depth value
       */
      public int getDepth();
  }