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
|
/*************************************************************************
*
* $RCSfile: RowSet.idl,v $
*
* $Revision: 1.6 $
*
* last change: $Author: mi $ $Date: 2002-10-03 13:06:58 $
*
* 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_RowSet_idl__
#define __com_sun_star_sdbc_RowSet_idl__
#ifndef __com_sun_star_sdbc_ResultSet_idl__
#include <com/sun/star/sdbc/ResultSet.idl>
#endif
#ifndef __com_sun_star_sdbc_XColumnLocate_idl__
#include <com/sun/star/sdbc/XColumnLocate.idl>
#endif
module com { module sun { module star { module container {
interface XNameAccess;
};};};};
module com { module sun { module star { module sdbc {
interface XRowSet;
interface XParameters;
// DocMerge from xml: service com::sun::star::container::com::sun::star::sdbc::RowSet
/** is a client side ResultSet, which combines the characteristics of a
<type scope="sun::com::star::sdbc">Statement</type>
and a
<type scope="sun::com::star::sdbc">ResultSet</type>
.
<p>
It acts like a typical bean. Before you use the RowSet, you have to specify a
set of properties like a DataSource and a Command and other properties known of
Statement.
<br/>
Afterwards, you can populate the RowSet by its execute method to fill the set
with data.
</p>
<p>
On the one hand, a RowSet can be used as a short cut to retrieve the data of a DataSource.
You don't have to establish a connection, create a Statement, and then create
a ResultSet. On the other hand, a rowset can be used to implement capabilties for
a result set, which are not supported by a driver result set, like caching
strategies or update capabilities.
</p>
*/
service RowSet
{
// DocMerge: empty anyway
service com::sun::star::sdbc::ResultSet;
// used to execute and to add/remove listeners.
interface XRowSet;
// used to set parameters.
interface XParameters;
/** allows locating columns which's name is known only.
*/
interface XColumnLocate;
// DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::DataSourceName
/** is the name of a named datasource to use.@see com::sun::star::sdbc:XDataSource
*/
[property] string DataSourceName;
// DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::URL
/** is the connection URL. Could be used instead of the DataSourceName.
*/
[property] string URL;
// DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::Command
/** is the command which should be executed.
*/
[property] string Command;
// DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::TransactionIsolation
/** indicates the transaction isolation level, which should be used for the
connection.@see com::sun::star::sdbc::TransactionIsolation
*/
[property] long TransactionIsolation;
// DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::TypeMap
/** is the type map that will be used for the custom mapping of SQL structured types
and distinct types.
*/
[property] com::sun::star::container::XNameAccess TypeMap;
// DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::EscapeProcessing
/** returns if escape processing is on or off.
If escape scanning is on (the default), the driver will do
escape substitution before sending the SQL to the database.
This is only evaluated, if the CommandType is COMMAND.
*/
[property] boolean EscapeProcessing;
// DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::QueryTimeOut
/** retrieves the number of seconds the driver will wait for a Statement
to execute. If the limit is exceeded, a
<type scope="sun::com::star::sdbc">SQLException</type>
is thrown.
There is no limitation, if set to zero.
*/
[property] long QueryTimeOut;
// DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::MaxFieldSize
/** returns the maximum number of bytes allowed for any column value.
<p>
This limit is the maximum number of bytes that can be returned
for any column value. The limit applies only to
<member scope= "com::sun::star::sdbc">DataType::BINARY</member>
,
<member scope= "com::sun::star::sdbc">DataType::VARBINARY</member>
,
<member scope= "com::sun::star::sdbc">DataType::LONGVARBINARY</member>
,
<member scope= "com::sun::star::sdbc">DataType::CHAR</member>
,
<member scope= "com::sun::star::sdbc">DataType::VARCHAR</member>
,
and
<member scope= "com::sun::star::sdbc">DataType::LONGVARCHAR</member>
columns.
If the limit is exceeded, the excess data is silently discarded.
<br/>
There is no limitation, if set to zero.
</p>
*/
[property] long MaxFieldSize;
// DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::MaxRows
/** retrieves the maximum number of rows that a ResultSet can contain.
If the limit is exceeded, the excess rows are silently dropped.
<br/>
There is no limitation, if set to zero.
*/
[property] long MaxRows;
// DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::User
/** determines the user for whom to open the connection.
*/
[property] string User;
// DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::Password
/** determines the user for whom to open the connection.
*/
[property] string Password;
// DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::ResultSetType
/** determine the result set type.@see com::sun::star::sdbc::ResultSetType;
*/
[property] long ResultSetType;
};
//=============================================================================
}; }; }; };
/*===========================================================================
$Log: not supported by cvs2svn $
Revision 1.5.2.3 2002/06/07 09:47:05 fs
added XColumnLocate
Revision 1.5.2.2 2002/02/18 12:55:23 oj
#97563# parameter,return value and exception description
Revision 1.5.2.1 2002/02/18 08:58:22 oj
#97563# parameter,return value and exception description
Revision 1.5 2001/11/01 16:46:46 mi
proofreading and corrections from Richard Holt
Revision 1.4 2001/02/20 13:30:07 fs
#82875# removed XClearParameters - this interface is obsolete, the functionality is covered by XParameters
Revision 1.3 2000/11/08 12:43:35 mi
moved from api
Revision 1.1.1.1 2000/09/18 23:35:41 hjs
initial import
Revision 1.7 2000/09/11 11:52:42 mi
documentation merged from XML
Revision 1.5 2000/01/27 08:08:01 dg
#72164# EscapeProcessing instead of UseEscapeProcessing
Revision 1.4 1999/12/20 16:11:34 dg
#70278# changes in API
Revision 1.3 1999/12/14 12:05:45 dg
#70278# CompareBookmark removed
Revision 1.2 1999/12/10 12:37:30 dg
#70278# documentation
Revision 1.1 1999/12/09 12:41:20 dg
#70278# new service
===========================================================================*/
#endif
|
