blob: 89251cbd0fd779dded4ec068ebe29413e546ba3b (
plain)
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
|
/**
*
* Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.tuscany.das.rdb;
import commonj.sdo.Type;
/**
* Describes a single parameter for a parameterized SQL statement.
*
*
*/
public interface Parameter {
/**
* Value for "Direction" that indicates that a parameter is soley for input.
*/
final static int IN = 1;
/**
* Value for "Direction" that indicates that a parameter is soley for
* output. Out parameters only apply to Stored Procedures
*/
final static int OUT = 2;
/**
* Value for "Direction" that indicates that a parameter is for both input
* and output. In-out parameters only apply to stored procedures
*/
final static int IN_OUT = 3;
/**
* A parameter has a type in terms of SDO2 DataTypes. Legal values are
* provided in {@link SDODataTypes}
* <p>
* Explicit definition of type is required only for OUT parameters of stored
* procedures commands
*
* @param type
*/
public void setType(Type type);
/**
* Set the index of the parameter. For example, if a SQL statement requires
* two parameters, the first one has an index of one.
*
* @param index
* The index of the parameter
*/
public void setIndex(int index);
/**
* Sets the name of the parameter
*
* @param name
* the parameter name
*/
public void setName(String name);
/**
* Sets the value of the parameter. All IN and IN_OUT parameters must be set
* beore a command can be executed.
*
* @param value
* The value for the parameter
*/
public void setValue(Object value);
/**
* Parameters are typically IN and this is the default. A parameter's
* direction must be set when the parameter is OUT or IN_OUT.
*
* @param direction
* the parameters direction
*/
public void setDirection(int direction);
/**
* TODO Not sure this method is needed.
* @param converter
*/
public void setConverter(Converter converter);
/**
* @return the type of the paramater in terms of {@link SDODataTypes}
*/
public Type getType();
/**
* TODO Not sure this is is needed.
* @return
*/
public Converter getConverter();
/**
* @return the index of the parameter
*/
public int getIndex();
/**
* @return the name of the parameter
*/
public String getName();
/**
* @return the value of the parameter
*/
public Object getValue();
/**
* @return the direction of the parameter
*/
public int getDirection();
}
|
