blob: 23d53174f349ef8f10804204bf206e4bfd0eb5f8 (
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
|
/*******************************************************************************
* Copyright (c) 2013 Oracle. 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:
* Oracle - initial API and implementation
******************************************************************************/
package org.eclipse.jpt.jpa.core.jpa2_1.resource.java;
import org.eclipse.jpt.common.core.utility.TextRange;
import org.eclipse.jpt.common.utility.iterable.ListIterable;
import org.eclipse.jpt.jpa.core.resource.java.QueryAnnotation;
/**
* Corresponds to the JPA annotation
* <code>javax.persistence.NamedStoredProcedureQuery</code>
* <p>
* Provisional API: This interface is part of an interim API that is still
* under development and expected to change significantly before reaching
* stability. It is available at this early stage to solicit feedback from
* pioneering adopters on the understanding that any code that uses this API
* will almost certainly be broken (repeatedly) as the API evolves.
*
* @version 3.3
* @since 3.3
*/
public interface NamedStoredProcedureQuery2_1Annotation
extends QueryAnnotation
{
String ANNOTATION_NAME = JPA2_1.NAMED_STORED_PROCEDURE_QUERY;
// ********** procedure name **********
/**
* Corresponds to the 'procedureName' element of the NamedStoredProcedureQuery annotation.
* Return null if the element does not exist in Java.
*/
String getProcedureName();
String PROCEDURE_NAME_PROPERTY = "procedureName"; //$NON-NLS-1$
/**
* Corresponds to the 'procedureName' element of the NamedStoredProcedureQuery annotation.
* Set to null to remove the element.
*/
void setProcedureName(String procedureName);
/**
* Return the {@link TextRange} for the 'procedureName' element. If element
* does not exist return the {@link TextRange} for the NamedStoredProcedureQuery annotation.
*/
TextRange getProcedureNameTextRange();
// ********** parameters **********
/**
* Corresponds to the 'parameters' element of the NamedStoredProcedureQuery annotation.
* Return an empty iterator if the element does not exist in Java.
*/
ListIterable<StoredProcedureParameter2_1Annotation> getParameters();
String PARAMETERS_LIST = "parameters"; //$NON-NLS-1$
/**
* Corresponds to the 'parameters' element of the NamedStoredProcedureQuery annotation.
*/
int getParametersSize();
/**
* Corresponds to the 'parameters' element of the NamedStoredProcedureQuery annotation.
*/
StoredProcedureParameter2_1Annotation parameterAt(int index);
/**
* Corresponds to the 'parameters' element of the NamedStoredProcedureQuery annotation.
*/
StoredProcedureParameter2_1Annotation addParameter(int index);
/**
* Corresponds to the 'parameters' element of the NamedStoredProcedureQuery annotation.
*/
void moveParameter(int targetIndex, int sourceIndex);
/**
* Corresponds to the 'parameters' element of the NamedStoredProcedureQuery annotation.
*/
void removeParameter(int index);
// ********** result classes **********
/**
* Corresponds to the 'resultClasses' element of the NamedStoredProcedureQuery annotation.
* Return an empty iterator if the element does not exist in Java.
*/
ListIterable<String> getResultClasses();
String RESULT_CLASSES_LIST = "resultClasses"; //$NON-NLS-1$
/**
* Corresponds to the 'resultClasses' element of the NamedStoredProcedureQuery annotation.
*/
int getResultClassesSize();
/**
* Corresponds to the 'resultClasses' element of the NamedStoredProcedureQuery annotation.
*/
String resultClassAt(int index);
/**
* Corresponds to the 'resultClasses' element of the NamedStoredProcedureQuery annotation.
*/
void addResultClass(String resultClass);
/**
* Corresponds to the 'resultClasses' element of the NamedStoredProcedureQuery annotation.
*/
void moveResultClass(int targetIndex, int sourceIndex);
/**
* Corresponds to the 'resultClasses' element of the NamedStoredProcedureQuery annotation.
*/
void removeResultClass(String resultClass);
/**
* Corresponds to the 'resultClasses' element of the NamedStoredProcedureQuery annotation.
*/
void removeResultClass(int index);
// ********** result set mappings **********
/**
* Corresponds to the 'resultSetMappings' element of the NamedStoredProcedureQuery annotation.
* Return an empty iterator if the element does not exist in Java.
*/
ListIterable<String> getResultSetMappings();
String RESULT_SET_MAPPINGS_LIST = "resultSetMappings"; //$NON-NLS-1$
/**
* Corresponds to the 'resultSetMappings' element of the NamedStoredProcedureQuery annotation.
*/
int getResultSetMappingsSize();
/**
* Corresponds to the 'resultSetMappings' element of the NamedStoredProcedureQuery annotation.
*/
String resultSetMappingAt(int index);
/**
* Corresponds to the 'resultSetMappings' element of the NamedStoredProcedureQuery annotation.
*/
void addResultSetMapping(String resultSetMapping);
/**
* Corresponds to the 'resultSetMappings' element of the NamedStoredProcedureQuery annotation.
*/
void moveResultSetMapping(int targetIndex, int sourceIndex);
/**
* Corresponds to the 'resultSetMappings' element of the NamedStoredProcedureQuery annotation.
*/
void removeResultSetMapping(String resultSetMapping);
/**
* Corresponds to the 'resultSetMappings' element of the NamedStoredProcedureQuery annotation.
*/
void removeResultSetMapping(int index);
}
|
