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
|
/* -*- 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_sdbc_XSQLInput_idl__
#define __com_sun_star_sdbc_XSQLInput_idl__
#include <com/sun/star/uno/XInterface.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;
};};};};
#include <com/sun/star/sdbc/SQLException.idl>
module com { module sun { module star { module sdbc {
published interface XRef;
published interface XArray;
published interface XBlob;
published interface XClob;
/** represents an input stream that contains a stream of values representing an
instance of a SQL structured or distinct type.
<p>
This interface, used only for custom mapping, is used by the driver
behind the scenes, and a programmer never directly invokes
<code>SQLInput</code>
methods.
</p>
<p>
When the method
<code>getObject</code>
is called with an object of a service implementing the interface
<code>SQLData</code>
, the SDBC driver calls the method
com::sun::star::sdbc::XSQLData::getSQLType()
to determine the SQL type of the user-defined type (UDT) being custom mapped.
The driver creates an instance of
com::sun::star::sdbc::XSQLInput
,
populating it with the attributes of the UDT. The driver then passes the input
stream to the method
com::sun::star::sdbc::XSQLData::readSQL()
, which in turn calls the
<code>XSQLInput.readXXX</code>
methods in its implementation for reading the attributes from the input stream.
</p>
*/
published interface XSQLInput: com::sun::star::uno::XInterface
{
/** reads the next attribute in the stream as string.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
string readString() raises (SQLException);
/** reads the next attribute in the stream as boolean.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
boolean readBoolean() raises (SQLException);
/** reads the next attribute in the stream as byte.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
byte readByte() raises (SQLException);
/** reads the next attribute in the stream as short.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
short readShort() raises (SQLException);
/** reads the next attribute in the stream as long.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
long readInt() raises (SQLException);
/** reads the next attribute in the stream as hyper.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
hyper readLong() raises (SQLException);
/** reads the next attribute in the stream as float.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
float readFloat() raises (SQLException);
/** reads the next attribute in the stream as double.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
double readDouble() raises (SQLException);
/** reads the next attribute in the stream as sequence of bytes.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
sequence<byte> readBytes() raises (SQLException);
/** reads the next attribute in the stream as date.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
com::sun::star::util::Date readDate() raises (SQLException);
/** reads the next attribute in the stream as time.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
com::sun::star::util::Time readTime() raises (SQLException);
/** reads the next attribute in the stream as datetime.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
com::sun::star::util::DateTime readTimestamp() raises (SQLException);
/** reads the next attribute in the stream as sequence of bytes.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
com::sun::star::io::XInputStream readBinaryStream() raises (SQLException);
/** reads the next attribute in the stream as a Unicode string.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
com::sun::star::io::XInputStream readCharacterStream() raises (SQLException);
/** returns the datum at the head of the stream as an any.
<p>
The actual type of the any returned is determined by the default
type mapping, and any customizations present in this stream's type map.
<br/>
A type map is registered with the stream by the SDBC driver before the
stream is passed to the application.
<br/>
When the datum at the head of the stream is a SQL NULL,
the method returns `VOID`. If the datum is a SQL structured or distinct
type, it determines the SQL type of the datum at the head of the stream,
constructs an object of the appropriate service, and calls the method
com::sun::star::sdbc::XSQLData::readSQL()
on that object, which reads additional data
from the stream using the protocol described for that method.
</p>
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
any readObject() raises (SQLException);
/** reads a REF(&lt;structured-type&gt;) from the stream.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
XRef readRef() raises (SQLException);
/** reads a BLOB from the stream.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
XBlob readBlob() raises (SQLException);
/** reads a CLOB from the stream.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
XClob readClob() raises (SQLException);
/** reads an array from the stream.
@returns
the attribute; if the value is SQL NULL, return null.
@throws SQLException
if a database access error occurs.
*/
XArray readArray() raises (SQLException);
/** determines whether the last value read was null.
@returns
<TRUE/> if the most recently gotten SQL value was null; otherwise, <FALSE/>
@throws SQLException
if a database access error occurs.
*/
boolean wasNull() raises (SQLException);
};
}; }; }; };
/*===========================================================================
===========================================================================*/
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
