blob: 9e0ba2a3b4544bc2ea3c970b3632fa3f93f05e50 (
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
|
/*******************************************************************************
* 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.resource.java.NestableAnnotation;
import org.eclipse.jpt.common.core.utility.TextRange;
/**
* Corresponds to the JPA annotation
* <code>javax.persistence.StoredProcedureParameter</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 StoredProcedureParameter2_1Annotation
extends NestableAnnotation
{
String ANNOTATION_NAME = JPA2_1.NAMED_STORED_PROCEDURE_PARAMETER;
// ********* name **********
/**
* Corresponds to the 'name' element of the StoredProcedureParameter annotation.
* Return null if the element does not exist in the annotation
*/
String getName();
String NAME_PROPERTY = "name"; //$NON-NLS-1$
/**
* Corresponds to the 'name' element of the StoredProcedureParameter annotation.
* Setting to null will remove the element.
*/
void setName(String name);
/**
* Return the {@link TextRange} for the 'name' element. If the element
* does not exist return the {@link TextRange} for the StoredProcedureParameter annotation.
*/
TextRange getNameTextRange();
// *********** mode *************
/**
* Corresponds to the 'mode' element of the StoredProcedureParameter annotation.
* Return null if the element does not exist in the annotation
*/
ParameterMode_2_1 getMode();
String MODE_PROPERTY = "mode"; //$NON-NLS-1$
/**
* Corresponds to the 'mode' element of the StoredProcedureParameter annotation.
* Setting to null will remove the element.
*/
void setMode(ParameterMode_2_1 mode);
/**
* Return the {@link TextRange} for the 'mode' element. If the element
* does not exist return the {@link TextRange} for the StoredProcedureParameter annotation.
*/
TextRange getModeTextRange();
// ********** type ***********
/**
* Corresponds to the 'type' element of the StoredProcedureParameter annotation.
* Return null if the element does not exist in the annotation
*/
String getTypeName();
String TYPE_PROPERTY = "type"; //$NON-NLS-1$
/**
* Corresponds to the 'type' element of the StoredProcedureParameter annotation.
* Setting to null will remove the element.
*/
void setTypeName(String type);
/**
* Return the {@link TextRange} for the 'type' element. If the element
* does not exist return the {@link TextRange} for the StoredProcedureParameter annotation.
*/
TextRange getTypeTextRange();
/**
* Return the named native query's fully-qualified type name as
* resolved by the AST's bindings.
* <pre>
* @NamedStoredProcedureQuery(type=Employee.class)
* </pre>
* will return <code>"model.Employee"</code> if there is an import for
* <code>model.Employee</code>.
*/
String getFullyQualifiedTypeName();
}
|