01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * 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: 57196 $
31: */
32: public interface DDBeanRoot extends DDBean {
33: // Constants -----------------------------------------------------
34:
35: // Public --------------------------------------------------------
36:
37: /**
38: * Return the module type of this descriptor
39: *
40: * @return the module type
41: */
42: ModuleType getType();
43:
44: /**
45: * Get the deployable object for this descriptor
46: *
47: * @return the deployable object
48: */
49: DeployableObject getDeployableObject();
50:
51: /**
52: * A convenience method for information on the deployable object
53: *
54: * @deprecated use getDDBeanRootVersion
55: * @return the dtd version
56: */
57: String getModuleDTDVersion();
58:
59: /**
60: * Return the version number of the j2ee xml document
61: *
62: * @return the version
63: */
64: String getDDBeanRootVersion();
65:
66: /**
67: * Returns the xpath, the root path is "/"
68: *
69: * @return the root path "/"
70: */
71: String getXpath();
72:
73: /**
74: * Returns the filename relative to the root of the module this XML
75: * instance document.
76: *
77: * @return The file name relative to the root of the module
78: */
79: String getFilename();
80: }
|