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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
|
/*******************************************************************************
* 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.core;
import java.util.List;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Persistence Context Ref</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
*
*
*
* The persistence-context-ref element contains a declaration
* of Deployment Component's reference to a persistence context
* associated within a Deployment Component's
* environment. It consists of:
*
* - an optional description
* - the persistence context reference name
* - an optional persistence unit name. If not specified,
* the default persistence unit is assumed.
* - an optional specification as to whether
* the persistence context type is Transaction or
* Extended. If not specified, Transaction is assumed.
* - an optional list of persistence properties
* - optional injection targets
*
* Examples:
*
* <persistence-context-ref>
* <persistence-context-ref-name>myPersistenceContext
* </persistence-context-ref-name>
* </persistence-context-ref>
*
* <persistence-context-ref>
* <persistence-context-ref-name>myPersistenceContext
* </persistence-context-ref-name>
* <persistence-unit-name>PersistenceUnit1
* </persistence-unit-name>
* <persistence-context-type>Extended</persistence-context-type>
* </persistence-context-ref>
*
*
*
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* <ul>
* <li>{@link org.eclipse.jst.javaee.core.PersistenceContextRef#getDescriptions <em>Descriptions</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.PersistenceContextRef#getPersistenceContextRefName <em>Persistence Context Ref Name</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.PersistenceContextRef#getPersistenceUnitName <em>Persistence Unit Name</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.PersistenceContextRef#getPersistenceContextType <em>Persistence Context Type</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.PersistenceContextRef#getPersistenceProperties <em>Persistence Properties</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.PersistenceContextRef#getMappedName <em>Mapped Name</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.PersistenceContextRef#getInjectionTargets <em>Injection Targets</em>}</li>
* <li>{@link org.eclipse.jst.javaee.core.PersistenceContextRef#getId <em>Id</em>}</li>
* </ul>
* </p>
*
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getPersistenceContextRef()
* @extends JavaEEObject
* @generated
*/
public interface PersistenceContextRef extends JavaEEObject {
/**
* Returns the value of the '<em><b>Descriptions</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.jst.javaee.core.Description}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Descriptions</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Descriptions</em>' containment reference list.
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getPersistenceContextRef_Descriptions()
* @generated
*/
List getDescriptions();
/**
* Returns the value of the '<em><b>Persistence Context Ref Name</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
*
*
* The persistence-context-ref-name element specifies
* the name of a persistence context reference; its
* value is the environment entry name used in
* Deployment Component code. The name is a JNDI name
* relative to the java:comp/env context.
*
*
* <!-- end-model-doc -->
* @return the value of the '<em>Persistence Context Ref Name</em>' attribute.
* @see #setPersistenceContextRefName(String)
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getPersistenceContextRef_PersistenceContextRefName()
* @generated
*/
String getPersistenceContextRefName();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.core.PersistenceContextRef#getPersistenceContextRefName <em>Persistence Context Ref Name</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Persistence Context Ref Name</em>' attribute.
* @see #getPersistenceContextRefName()
* @generated
*/
void setPersistenceContextRefName(String value);
/**
* Returns the value of the '<em><b>Persistence Unit Name</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
*
*
* The Application Assembler(or BeanProvider) may use the
* following syntax to avoid the need to rename persistence
* units to have unique names within a Java EE application.
*
* The Application Assembler specifies the pathname of the
* root of the persistence.xml file for the referenced
* persistence unit and appends the name of the persistence
* unit separated from the pathname by #. The pathname is
* relative to the referencing application component jar file.
* In this manner, multiple persistence units with the same
* persistence unit name may be uniquely identified when the
* Application Assembler cannot change persistence unit names.
*
*
* <!-- end-model-doc -->
* @return the value of the '<em>Persistence Unit Name</em>' attribute.
* @see #setPersistenceUnitName(String)
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getPersistenceContextRef_PersistenceUnitName()
* @generated
*/
String getPersistenceUnitName();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.core.PersistenceContextRef#getPersistenceUnitName <em>Persistence Unit Name</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Persistence Unit Name</em>' attribute.
* @see #getPersistenceUnitName()
* @generated
*/
void setPersistenceUnitName(String value);
/**
* Returns the value of the '<em><b>Persistence Context Type</b></em>' attribute.
* The default value is <code>"Transaction"</code>.
* The literals are from the enumeration {@link org.eclipse.jst.javaee.core.PersistenceContextType}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Persistence Context Type</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Persistence Context Type</em>' attribute.
* @see org.eclipse.jst.javaee.core.PersistenceContextType
* @see #isSetPersistenceContextType()
* @see #unsetPersistenceContextType()
* @see #setPersistenceContextType(PersistenceContextType)
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getPersistenceContextRef_PersistenceContextType()
* @generated
*/
PersistenceContextType getPersistenceContextType();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.core.PersistenceContextRef#getPersistenceContextType <em>Persistence Context Type</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Persistence Context Type</em>' attribute.
* @see org.eclipse.jst.javaee.core.PersistenceContextType
* @see #isSetPersistenceContextType()
* @see #unsetPersistenceContextType()
* @see #getPersistenceContextType()
* @generated
*/
void setPersistenceContextType(PersistenceContextType value);
/**
* Unsets the value of the '{@link org.eclipse.jst.javaee.core.PersistenceContextRef#getPersistenceContextType <em>Persistence Context Type</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetPersistenceContextType()
* @see #getPersistenceContextType()
* @see #setPersistenceContextType(PersistenceContextType)
* @generated
*/
void unsetPersistenceContextType();
/**
* Returns whether the value of the '{@link org.eclipse.jst.javaee.core.PersistenceContextRef#getPersistenceContextType <em>Persistence Context Type</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Persistence Context Type</em>' attribute is set.
* @see #unsetPersistenceContextType()
* @see #getPersistenceContextType()
* @see #setPersistenceContextType(PersistenceContextType)
* @generated
*/
boolean isSetPersistenceContextType();
/**
* Returns the value of the '<em><b>Persistence Properties</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.jst.javaee.core.PropertyType}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
*
*
* Used to specify properties for the container or persistence
* provider. Vendor-specific properties may be included in
* the set of properties. Properties that are not recognized
* by a vendor must be ignored. Entries that make use of the
* namespace javax.persistence and its subnamespaces must not
* be used for vendor-specific properties. The namespace
* javax.persistence is reserved for use by the specification.
*
*
* <!-- end-model-doc -->
* @return the value of the '<em>Persistence Properties</em>' containment reference list.
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getPersistenceContextRef_PersistenceProperties()
* @generated
*/
List getPersistenceProperties();
/**
* Returns the value of the '<em><b>Mapped Name</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
*
*
*
* A product specific name that this resource should be
* mapped to. The name of this resource, as defined by the
* resource's name element or defaulted, is a name that is
* local to the application component using the resource.
* (It's a name in the JNDI java:comp/env namespace.) Many
* application servers provide a way to map these local
* names to names of resources known to the application
* server. This mapped name is often a global JNDI name,
* but may be a name of any form.
*
* Application servers are not required to support any
* particular form or type of mapped name, nor the ability
* to use mapped names. The mapped name is
* product-dependent and often installation-dependent. No
* use of a mapped name is portable.
*
*
*
* <!-- end-model-doc -->
* @return the value of the '<em>Mapped Name</em>' attribute.
* @see #setMappedName(String)
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getPersistenceContextRef_MappedName()
* @generated
*/
String getMappedName();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.core.PersistenceContextRef#getMappedName <em>Mapped Name</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Mapped Name</em>' attribute.
* @see #getMappedName()
* @generated
*/
void setMappedName(String value);
/**
* Returns the value of the '<em><b>Injection Targets</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.jst.javaee.core.InjectionTarget}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Injection Targets</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Injection Targets</em>' containment reference list.
* @see org.eclipse.jst.javaee.core.internal.metadata.JavaeePackage#getPersistenceContextRef_InjectionTargets()
* @generated
*/
List getInjectionTargets();
/**
* 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.core.internal.metadata.JavaeePackage#getPersistenceContextRef_Id()
* @generated
*/
String getId();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.core.PersistenceContextRef#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);
} // PersistenceContextRef
|
