1   /*
    2   * JBoss, Home of Professional Open Source
    3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
    4   * by the @authors tag. See the copyright.txt in the distribution for a
    5   * full listing of individual contributors.
    6   *
    7   * This is free software; you can redistribute it and/or modify it
    8   * under the terms of the GNU Lesser General Public License as
    9   * published by the Free Software Foundation; either version 2.1 of
   10   * the License, or (at your option) any later version.
   11   *
   12   * This software is distributed in the hope that it will be useful,
   13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   15   * Lesser General Public License for more details.
   16   *
   17   * You should have received a copy of the GNU Lesser General Public
   18   * License along with this software; if not, write to the Free
   19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
   20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
   21   */
   22   package javax.enterprise.deploy.model;
   23   
   24   import javax.enterprise.deploy.shared.ModuleType;
   25   
   26   /**
   27    * The root of a DDBean tree (a standard deployment descriptor)
   28    *
   29    * @author <a href="mailto:adrian@jboss.org">Adrian Brock</a>
   30    * @version $Revision: 37459 $
   31    */
   32   public interface DDBeanRoot extends DDBean
   33   {
   34      // Constants -----------------------------------------------------
   35      
   36      // Public --------------------------------------------------------
   37   
   38      /**
   39       * Return the module type of this descriptor
   40       *
   41       * @return the module type
   42       */
   43      ModuleType getType();
   44      
   45      /**
   46       * Get the deployable object for this descriptor
   47       *
   48       * @return the deployable object 
   49       */
   50      DeployableObject getDeployableObject();
   51      
   52      /**
   53       * A convenience method for information on the deployable object
   54       * 
   55       * @deprecated use getDDBeanRootVersion
   56       * @return the dtd version
   57       */
   58      String getModuleDTDVersion();
   59      
   60      /**
   61       * Return the version number of the j2ee xml document
   62       *
   63       * @return the version
   64       */
   65      String getDDBeanRootVersion();
   66      
   67      /**
   68       * Returns the xpath, the root path is "/"
   69       *
   70       * @return the root path "/"
   71       */
   72      String getXpath();
   73      
   74      /**
   75       * Returns the filename relative to the root of the module this XML
   76       * instance document.
   77       *
   78       * @return The file name relative to the root of the module
   79       */
   80      String getFilename();
   81   }