xref: /aoo42x/main/offapi/com/sun/star/sdbc/RowSet.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdbc_RowSet_idl__
24#define __com_sun_star_sdbc_RowSet_idl__
25
26#ifndef __com_sun_star_sdbc_ResultSet_idl__
27#include <com/sun/star/sdbc/ResultSet.idl>
28#endif
29#ifndef __com_sun_star_sdbc_XColumnLocate_idl__
30#include <com/sun/star/sdbc/XColumnLocate.idl>
31#endif
32
33 module com {  module sun {  module star {  module container {
34 published interface XNameAccess;
35};};};};
36
37 module com {  module sun {  module star {  module sdbc {
38
39 published interface XRowSet;
40 published interface XParameters;
41
42
43/** is a client side ResultSet, which combines the characteristics of a
44	<type scope="com::sun::star::sdbc">Statement</type>
45	and a
46	<type scope="com::sun::star::sdbc">ResultSet</type>.
47
48
49	<p>
50	It acts like a typical bean. Before you use the RowSet, you have to specify a
51	set of properties like a DataSource and a Command and other properties known of
52	Statement.
53	<br/>
54	Afterwards, you can populate the RowSet by its execute method to fill the set
55	with data.
56	</p>
57	<p>
58	On the one hand, a RowSet can be used as a short cut to retrieve the data of a DataSource.
59	You don't have to establish a connection, create a Statement, and then create
60	a ResultSet. On the other hand, a rowset can be used to implement capabilties for
61	a result set, which are not supported by a driver result set, like caching
62	strategies or update capabilities.
63	</p>
64 */
65published service RowSet
66{
67	service com::sun::star::sdbc::ResultSet;
68
69	/** used to execute and to add/remove listeners.
70
71        <p>To refresh the content of a <type>RowSet</type>, use this interface's <member>XRowSet::execute</member>
72        method.</p>
73    */
74	interface XRowSet;
75
76	// used to set parameters.
77	interface XParameters;
78
79	/** allows locating columns which's name is known only.
80	*/
81	interface XColumnLocate;
82
83	/** is the name of a named datasource to use.@see com::sun::star::sdbc:XDataSource
84	 */
85	[property] string DataSourceName;
86
87
88	/** is the connection URL. Could be used instead of the DataSourceName.
89	 */
90	[property] string URL;
91
92
93	/** is the command which should be executed.
94	 */
95	[property] string Command;
96
97
98	/** indicates the transaction isolation level, which should be used for the
99		connection.@see com::sun::star::sdbc::TransactionIsolation
100	 */
101	[property] long TransactionIsolation;
102
103
104	/** is the type map that will be used for the custom mapping of SQL structured types
105		and distinct types.
106	 */
107	[property] com::sun::star::container::XNameAccess TypeMap;
108
109
110	/** returns if escape processing is on or off.
111		If escape scanning is on (the default), the driver will do
112		escape substitution before sending the SQL to the database.
113		This is only evaluated, if the CommandType is COMMAND.
114	 */
115	[property] boolean EscapeProcessing;
116
117
118	/** retrieves the number of seconds the driver will wait for a Statement
119		to execute. If the limit is exceeded, a
120		<type scope="com::sun::star::sdbc">SQLException</type>
121		is thrown.
122		There is no limitation, if set to zero.
123	 */
124	[property] long QueryTimeOut;
125
126
127	/** returns the maximum number of bytes allowed for any column value.
128
129		<p>
130		This limit is the maximum number of bytes that can be returned
131		for any column value. The limit applies only to
132		<member scope= "com::sun::star::sdbc">DataType::BINARY</member>
133			  ,
134			  <member scope= "com::sun::star::sdbc">DataType::VARBINARY</member>
135			  ,
136			  <member scope= "com::sun::star::sdbc">DataType::LONGVARBINARY</member>
137			  ,
138			  <member scope= "com::sun::star::sdbc">DataType::CHAR</member>
139			  ,
140			  <member scope= "com::sun::star::sdbc">DataType::VARCHAR</member>
141			  ,
142			  and
143			  <member scope= "com::sun::star::sdbc">DataType::LONGVARCHAR</member>
144			  columns.
145		If the limit is exceeded, the excess data is silently discarded.
146		<br/>
147		There is no limitation, if set to zero.
148		</p>
149	 */
150	[property] long MaxFieldSize;
151
152
153	/** retrieves the maximum number of rows that a ResultSet can contain.
154		If the limit is exceeded, the excess rows are silently dropped.
155		<br/>
156		There is no limitation, if set to zero.
157	 */
158	[property] long MaxRows;
159
160
161	/** determines the user for whom to open the connection.
162	 */
163	[property] string User;
164
165
166	/** determines the user for whom to open the connection.
167	 */
168	[property] string Password;
169
170
171	/** determine the result set type.
172
173		@see com::sun::star::sdbc::ResultSetType
174	 */
175	[property] long ResultSetType;
176};
177
178//=============================================================================
179
180}; }; }; };
181
182/*===========================================================================
183===========================================================================*/
184#endif
185