blob: 1ac46d82726fa9d50b91127db26f071dc0bdf615 (
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
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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you 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 .
*/
#ifndef __com_sun_star_sdb_XColumn_idl__
#define __com_sun_star_sdb_XColumn_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/sdbc/SQLException.idl>
#include <com/sun/star/util/Date.idl>
#include <com/sun/star/util/DateTime.idl>
#include <com/sun/star/util/Time.idl>
module com { module sun { module star { module io {
published interface XInputStream;
};};};};
module com { module sun { module star { module container {
published interface XNameAccess;
};};};};
module com { module sun { module star { module sdbc {
published interface XRef;
published interface XArray;
published interface XBlob;
published interface XClob;
};};};};
module com { module sun { module star { module sdb {
/** is used to access data which is collected in a row.
*/
published interface XColumn: com::sun::star::uno::XInterface
{
/** 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
<code>wasNull()</code>
to see if the value read was SQL NULL.
@returns
`TRUE` if so
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
boolean wasNull() raises (com::sun::star::sdbc::SQLException);
/** gets the value of a column in the current row as a String.
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
string getString() raises (com::sun::star::sdbc::SQLException);
/** gets the value of a column in the current row as boolean.
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
boolean getBoolean() raises (com::sun::star::sdbc::SQLException);
/** gets the value of a column in the current row as a byte.
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
byte getByte() raises (com::sun::star::sdbc::SQLException);
/** gets the value of a column in the current row as a short.
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
short getShort() raises (com::sun::star::sdbc::SQLException);
/** gets the value of a column in the current row as a long.
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
long getInt() raises (com::sun::star::sdbc::SQLException);
/** gets the value of a column in the current row as a hyper.
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
hyper getLong() raises (com::sun::star::sdbc::SQLException);
/** gets the value of a column in the current row as a float.
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
float getFloat() raises (com::sun::star::sdbc::SQLException);
/** gets the value of a column in the current row as a double.
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
double getDouble() raises (com::sun::star::sdbc::SQLException);
/** gets the value of a column in the current row as a byte array.
The bytes represent the raw values returned by the driver.
@returns the column value;
if the value is SQL NULL, the result is empty.
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
sequence<byte> getBytes() raises (com::sun::star::sdbc::SQLException);
/** gets the value of a column in the current row as a date object.
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
com::sun::star::util::Date getDate()
raises (com::sun::star::sdbc::SQLException);
/** gets the value of a column in the current row as a time object.
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
com::sun::star::util::Time getTime()
raises (com::sun::star::sdbc::SQLException);
/** gets the value of a column in the current row as a datetime object.
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
com::sun::star::util::DateTime getTimestamp()
raises (com::sun::star::sdbc::SQLException);
/** 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
com::sun::star::io::XInputStream::available()
is called whether there is data available or not.
</p>
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
com::sun::star::io::XInputStream getBinaryStream()
raises (com::sun::star::sdbc::SQLException);
/** 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
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
com::sun::star::io::XInputStream::available()
is called whether there is data available or not.
</p>
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
com::sun::star::io::XInputStream getCharacterStream()
raises (com::sun::star::sdbc::SQLException);
/** @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 typeMap
the type map is used to fetch the correct type
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
any getObject([in]com::sun::star::container::XNameAccess typeMap)
raises (com::sun::star::sdbc::SQLException);
/** gets a REF(<structured-type>) column value from the current row.
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
com::sun::star::sdbc::XRef getRef() raises (com::sun::star::sdbc::SQLException);
/** gets a BLOB (Binary Large OBject) value in the current row.
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
com::sun::star::sdbc::XBlob getBlob() raises (com::sun::star::sdbc::SQLException);
/** gets a CLOB value in the current row of this <code>ResultSet</code> object.
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
com::sun::star::sdbc::XClob getClob() raises (com::sun::star::sdbc::SQLException);
/** gets a SQL ARRAY value from the current row.
@returns
the column value
@throws com::sun::star::sdbc::SQLException
if a database access error occurs.
*/
com::sun::star::sdbc::XArray getArray() raises (com::sun::star::sdbc::SQLException);
};
}; }; }; };
/*===========================================================================
===========================================================================*/
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
