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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
|
/* CallableStatement.java -- A statement for calling stored procedures.
Copyright (C) 1999, 2000 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.
As a special exception, if you link this library with other files to
produce an executable, this library does not by itself cause the
resulting executable to be covered by the GNU General Public License.
This exception does not however invalidate any other reasons why the
executable file might be covered by the GNU General Public License. */
package java.sql;
import java.io.InputStream;
import java.io.Reader;
import java.math.BigDecimal;
import java.util.Calendar;
import java.util.Map;
/**
* This interface provides a mechanism for calling stored procedures.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
*/
public interface CallableStatement extends PreparedStatement
{
/*************************************************************************/
/**
* This method tests whether the value of the last parameter that was fetched
* was actually a SQL NULL value.
*
* @return <code>true</code> if the last parameter fetched was a NULL,
* <code>false</code> otherwise.
*
* @exception SQLException If an error occurs.
*/
public abstract boolean
wasNull() throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>String</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>String</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract String
getString(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>Object</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as an <code>Object</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract Object
getObject(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>Object</code>.
*
* @param index The index of the parameter to return.
* @param map The mapping to use for conversion from SQL to Java types.
*
* @return The parameter value as an <code>Object</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract Object
getObject(int index, Map map) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>boolean</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>boolean</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract boolean
getBoolean(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>byte</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>byte</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract byte
getByte(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>short</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>short</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract short
getShort(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>int</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>int</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract int
getInt(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>long</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>long</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract long
getLong(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>float</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>float</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract float
getFloat(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>double</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>double</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract double
getDouble(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>BigDecimal</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>BigDecimal</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract BigDecimal
getBigDecimal(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>BigDecimal</code>.
*
* @param index The index of the parameter to return.
* @param scale The number of digits to the right of the decimal to return.
*
* @return The parameter value as a <code>BigDecimal</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract BigDecimal
getBigDecimal(int index, int scale) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* byte array.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a byte array
*
* @exception SQLException If an error occurs.
*/
public abstract byte[]
getBytes(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>java.sql.Date</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>java.sql.Date</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract java.sql.Date
getDate(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>java.sql.Date</code>.
*
* @param index The index of the parameter to return.
* @param calendar The <code>Calendar</code> to use for timezone and locale.
*
* @return The parameter value as a <code>java.sql.Date</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract java.sql.Date
getDate(int index, Calendar calendar) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>java.sql.Time</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>java.sql.Time</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract java.sql.Time
getTime(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>java.sql.Time</code>.
*
* @param index The index of the parameter to return.
* @param calendar The <code>Calendar</code> to use for timezone and locale.
*
* @return The parameter value as a <code>java.sql.Time</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract java.sql.Time
getTime(int index, Calendar calendar) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>java.sql.Timestamp</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>java.sql.Timestamp</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract java.sql.Timestamp
getTimestamp(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>java.sql.Timestamp</code>.
*
* @param index The index of the parameter to return.
* @param calendar The <code>Calendar</code> to use for timezone and locale.
*
* @return The parameter value as a <code>java.sql.Timestamp</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract java.sql.Timestamp
getTimestamp(int index, Calendar calendar) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>Ref</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>Ref</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract Ref
getRef(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>Blob</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>Blob</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract Blob
getBlob(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>Clob</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>Clob</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract Clob
getClob(int index) throws SQLException;
/*************************************************************************/
/**
* This method returns the value of the specified parameter as a Java
* <code>Array</code>.
*
* @param index The index of the parameter to return.
*
* @return The parameter value as a <code>Array</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract Array
getArray(int index) throws SQLException;
/*************************************************************************/
/**
* This method registers the specified parameter as an output parameter
* of the specified SQL type.
*
* @param index The index of the parameter to register as output.
* @param type The SQL type value from <code>Types</code>.
*
* @exception SQLException If an error occurs.
*/
public abstract void
registerOutParameter(int index, int type) throws SQLException;
/*************************************************************************/
/**
* This method registers the specified parameter as an output parameter
* of the specified SQL type.
*
* @param index The index of the parameter to register as output.
* @param type The SQL type value from <code>Types</code>.
* @param name The user defined data type name.
*
* @exception SQLException If an error occurs.
*/
public abstract void
registerOutParameter(int index, int type, String name) throws SQLException;
/*************************************************************************/
/**
* This method registers the specified parameter as an output parameter
* of the specified SQL type and scale.
*
* @param index The index of the parameter to register as output.
* @param type The SQL type value from <code>Types</code>.
* @param scale The scale of the value that will be returned.
*
* @exception SQLException If an error occurs.
*/
public abstract void
registerOutParameter(int index, int type, int scale) throws SQLException;
} // interface CallableStatement
|
