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
|
/*************************************************************************
*
* $RCSfile: XRow.idl,v $
*
* $Revision: 1.8 $
*
* last change: $Author: hr $ $Date: 2003-03-26 13:55:32 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_sdbc_XRow_idl__
#define __com_sun_star_sdbc_XRow_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_util_Date_idl__
#include <com/sun/star/util/Date.idl>
#endif
#ifndef __com_sun_star_util_DateTime_idl__
#include <com/sun/star/util/DateTime.idl>
#endif
#ifndef __com_sun_star_util_Time_idl__
#include <com/sun/star/util/Time.idl>
#endif
module com { module sun { module star { module io {
interface XInputStream;
};};};};
module com { module sun { module star { module container {
interface XNameAccess;
};};};};
#ifndef __com_sun_star_sdbc_SQLException_idl__
#include <com/sun/star/sdbc/SQLException.idl>
#endif
module com { module sun { module star { module sdbc {
interface XRef;
interface XArray;
interface XBlob;
interface XClob;
// DocMerge from xml: interface com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow
/** is used to access data which is collected in a row.
All methods raise a
<type scope="com::sun::star::sdbc">SQLException</type>
if a database access error occurs.
*/
interface XRow: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::wasNull
/** reports whether the last column read had a value of SQL NULL.
Note that you must first call getXXX on a column to try to read
its value and then call wasNull() to see if the value read was
SQL NULL.
@returns
<TRUE/> if last column read was SQL NULL and <FALSE/> otherwise
@throws SQLException
if a database access error occurs.
*/
boolean wasNull() raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getString
/** gets the value of a column in the current row as a string.
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
string getString([in]long columnIndex) raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBoolean
/** gets the value of a column in the current row as boolean.
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
boolean getBoolean([in]long columnIndex) raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getByte
/** get the value of a column in the current row as a byte.
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
byte getByte([in]long columnIndex) raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getShort
/** gets the value of a column in the current row as a short.
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
short getShort([in]long columnIndex) raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getInt
/** get the value of a column in the current row as an integer.
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
long getInt([in]long columnIndex) raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getLong
/** get the value of a column in the current row as a long.
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
hyper getLong([in]long columnIndex) raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getFloat
/** gets the value of a column in the current row as a float.
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
float getFloat([in]long columnIndex) raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getDouble
/** gets the value of a column in the current row as a double.
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
double getDouble([in]long columnIndex) raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBytes
/** gets the value of a column in the current row as a byte array.
The bytes represent the raw values returned by the driver.
@param columnIndex
the first column is 1, the second is 2, ...
@returns
the column value; if the value is SQL NULL, the result is empty.
@throws SQLException
if a database access error occurs.
*/
sequence<byte> getBytes([in]long columnIndex) raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getDate
/** gets the value of a column in the current row as a date object.
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
com::sun::star::util::Date getDate([in]long columnIndex)
raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getTime
/** gets the value of a column in the current row as a time object.
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
com::sun::star::util::Time getTime([in]long columnIndex)
raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getTimestamp
/** gets the value of a column in the current row as a datetime object.
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
com::sun::star::util::DateTime getTimestamp([in]long columnIndex)
raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBinaryStream
/** gets the value of a column in the current row as a stream of
uninterpreted bytes. The value can then be read in chunks from the
stream. This method is particularly suitable for retrieving large
LONGVARBINARY values.
<p>
<b>Note:</b> All the data in the returned stream must be
read prior to getting the value of any other column. The next
call to a get method implicitly closes the stream. Also, a
stream may return 0 when the method
<member scope="com::sun::star::io">XInputStream::available()</member>
is called whether there is data
available or not.
</p>
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
com::sun::star::io::XInputStream getBinaryStream([in]long columnIndex)
raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getCharacterStream
/** gets the value of a column in the current row as a stream of
uninterpreted bytes. The value can then be read in chunks from the
stream. This method is particularly suitable for retrieving large
LONGVARBINARY or LONGVARCHAR values.
<p>
<b>Note:</b> All the data in the returned stream must be
read prior to getting the value of any other column. The next
call to a get method implicitly closes the stream. Also, a
stream may return 0 when the method
<member scope="com::sun::star::io">XInputStream::available()</member>
is called whether there is data
available or not.
</p>
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
com::sun::star::io::XInputStream getCharacterStream([in]long columnIndex)
raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getObject
/** returns the value of a column in the current row as an object.
This method uses the given
<code>Map</code>
object for the custom mapping of the SQL structure or distinct type
that is being retrieved.
@param columnIndex
the first column is 1, the second is 2,
@param typeMap
the map of types which should be used to get the column value
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
any getObject([in]long columnIndex,
[in]com::sun::star::container::XNameAccess typeMap)
raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getRef
/** gets a REF(&lt;structured-type&gt;) column value from the current row.
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
XRef getRef([in]long columnIndex) raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBlob
/** gets a BLOB value in the current row.
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
XBlob getBlob([in]long columnIndex) raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getClob
/** gets a CLOB value in the current row of this
<code>ResultSet</code>
object.
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
XClob getClob([in]long columnIndex) raises (SQLException);
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getArray
/** gets a SQL ARRAY value from the current row of this
<code>ResultSet</code>
object.
@param columnIndex
the first column is 1, the second is 2,
@returns
the column value; if the value is SQL NULL, the result is null
@throws SQLException
if a database access error occurs.
*/
XArray getArray([in]long columnIndex) raises (SQLException);
};
//=============================================================================
}; }; }; };
/*===========================================================================
===========================================================================*/
#endif
|
