Skip to main content
summaryrefslogtreecommitdiffstats
blob: fc2f4c4d9f934cf1a5705e6236c21dfa201a75d4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
/*******************************************************************************
 * Copyright (c) 2007 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 * IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jst.javaee.application;

import org.eclipse.jst.javaee.core.JavaEEObject;

/**
 * <!-- begin-user-doc -->
 * A representation of the model object '<em><b>Module</b></em>'.
 * <!-- end-user-doc -->
 *
 * <!-- begin-model-doc -->
 * 
 * 
 *         The moduleType defines a single Java EE module and contains a
 *         connector, ejb, java, or web element, which indicates the
 *         module type and contains a path to the module file, and an
 *         optional alt-dd element, which specifies an optional URI to
 *         the post-assembly version of the deployment descriptor.
 *         
 *         @since Java EE 5, Application 5
 *       
 * <!-- end-model-doc -->
 *
 * <p>
 * The following features are supported:
 * <ul>
 *   <li>{@link org.eclipse.jst.javaee.application.Module#getConnector <em>Connector</em>}</li>
 *   <li>{@link org.eclipse.jst.javaee.application.Module#getEjb <em>Ejb</em>}</li>
 *   <li>{@link org.eclipse.jst.javaee.application.Module#getJava <em>Java</em>}</li>
 *   <li>{@link org.eclipse.jst.javaee.application.Module#getWeb <em>Web</em>}</li>
 *   <li>{@link org.eclipse.jst.javaee.application.Module#getAltDd <em>Alt Dd</em>}</li>
 *   <li>{@link org.eclipse.jst.javaee.application.Module#getId <em>Id</em>}</li>
 * </ul>
 * </p>
 *
 * @see org.eclipse.jst.javaee.application.internal.metadata.ApplicationPackage#getModule()
 * @extends JavaEEObject
 * @generated
 */
public interface Module extends JavaEEObject {
	/**
	 * Returns the value of the '<em><b>Connector</b></em>' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * 
	 * 
	 *               The connector element specifies the URI of a
	 *               resource adapter archive file, relative to the
	 *               top level of the application package.
	 *               
	 *               @since Java EE 5, Application 5
	 *             
	 * <!-- end-model-doc -->
	 * @return the value of the '<em>Connector</em>' attribute.
	 * @see #setConnector(String)
	 * @see org.eclipse.jst.javaee.application.internal.metadata.ApplicationPackage#getModule_Connector()
	 * @generated
	 */
	String getConnector();

	/**
	 * Sets the value of the '{@link org.eclipse.jst.javaee.application.Module#getConnector <em>Connector</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Connector</em>' attribute.
	 * @see #getConnector()
	 * @generated
	 */
	void setConnector(String value);

	/**
	 * Returns the value of the '<em><b>Ejb</b></em>' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * 
	 * 
	 *               The ejb element specifies the URI of an ejb-jar,
	 *               relative to the top level of the application
	 *               package.
	 *               
	 *               @since Java EE 5, Application 5
	 *             
	 * <!-- end-model-doc -->
	 * @return the value of the '<em>Ejb</em>' attribute.
	 * @see #setEjb(String)
	 * @see org.eclipse.jst.javaee.application.internal.metadata.ApplicationPackage#getModule_Ejb()
	 * @generated
	 */
	String getEjb();

	/**
	 * Sets the value of the '{@link org.eclipse.jst.javaee.application.Module#getEjb <em>Ejb</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Ejb</em>' attribute.
	 * @see #getEjb()
	 * @generated
	 */
	void setEjb(String value);

	/**
	 * Returns the value of the '<em><b>Java</b></em>' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * 
	 * 
	 *               The java element specifies the URI of a java
	 *               application client module, relative to the top
	 *               level of the application package.
	 *               
	 *               @since Java EE 5, Application 5
	 *             
	 * <!-- end-model-doc -->
	 * @return the value of the '<em>Java</em>' attribute.
	 * @see #setJava(String)
	 * @see org.eclipse.jst.javaee.application.internal.metadata.ApplicationPackage#getModule_Java()
	 * @generated
	 */
	String getJava();

	/**
	 * Sets the value of the '{@link org.eclipse.jst.javaee.application.Module#getJava <em>Java</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Java</em>' attribute.
	 * @see #getJava()
	 * @generated
	 */
	void setJava(String value);

	/**
	 * Returns the value of the '<em><b>Web</b></em>' containment reference.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Web</em>' containment reference isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Web</em>' containment reference.
	 * @see #setWeb(Web)
	 * @see org.eclipse.jst.javaee.application.internal.metadata.ApplicationPackage#getModule_Web()
	 * @generated
	 */
	Web getWeb();

	/**
	 * Sets the value of the '{@link org.eclipse.jst.javaee.application.Module#getWeb <em>Web</em>}' containment reference.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Web</em>' containment reference.
	 * @see #getWeb()
	 * @generated
	 */
	void setWeb(Web value);

	/**
	 * Returns the value of the '<em><b>Alt Dd</b></em>' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * 
	 * 
	 *             The alt-dd element specifies an optional URI to the
	 *             post-assembly version of the deployment descriptor
	 *             file for a particular Java EE module.  The URI must
	 *             specify the full pathname of the deployment
	 *             descriptor file relative to the application's root
	 *             directory. If alt-dd is not specified, the deployer
	 *             must read the deployment descriptor from the default
	 *             location and file name required by the respective
	 *             component specification.
	 *             
	 *             @since Java EE 5, Application 5
	 *           
	 * <!-- end-model-doc -->
	 * @return the value of the '<em>Alt Dd</em>' attribute.
	 * @see #setAltDd(String)
	 * @see org.eclipse.jst.javaee.application.internal.metadata.ApplicationPackage#getModule_AltDd()
	 * @generated
	 */
	String getAltDd();

	/**
	 * Sets the value of the '{@link org.eclipse.jst.javaee.application.Module#getAltDd <em>Alt Dd</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Alt Dd</em>' attribute.
	 * @see #getAltDd()
	 * @generated
	 */
	void setAltDd(String value);

	/**
	 * Returns the value of the '<em><b>Id</b></em>' attribute.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Id</em>' attribute isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Id</em>' attribute.
	 * @see #setId(String)
	 * @see org.eclipse.jst.javaee.application.internal.metadata.ApplicationPackage#getModule_Id()
	 * @generated
	 */
	String getId();

	/**
	 * Sets the value of the '{@link org.eclipse.jst.javaee.application.Module#getId <em>Id</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Id</em>' attribute.
	 * @see #getId()
	 * @generated
	 */
	void setId(String value);

	public String getUri();

} // Module

Back to the top