xref: /aoo42x/main/offapi/com/sun/star/sdbc/XRowSet.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_XRowSet_idl__
24#define __com_sun_star_sdbc_XRowSet_idl__
25
26#ifndef __com_sun_star_sdbc_XResultSet_idl__
27#include <com/sun/star/sdbc/XResultSet.idl>
28#endif
29
30 module com {  module sun {  module star {  module sdbc {
31
32 published interface XRowSetListener;
33 published interface XConnection;
34
35
36/** enhances the functionality of a result set. It allows implementation of
37	a special behavior for a result set and notifies an application on
38	certain row set events such as a change in its value.
39
40
41
42	<p>
43	The XRowSet interface is unique in that it is intended to be
44	a software layer on top of an SDBC driver. Implementations of the
45	RowSet interface can be provided by anyone.
46	</p>
47 */
48published interface XRowSet: XResultSet
49{
50	//-------------------------------------------------------------------------
51
52	/** populates a row set with data. The description of the data source and
53		other important information for filling the row set with data.
54
55		@throws SQLException
56			if a database access error occurs.
57	 */
58	void execute() raises (SQLException);
59	//-------------------------------------------------------------------------
60
61	/** adds the specified listener to receive the events "cursorMoved",
62		"rowChanged", and "rowSetChanged".
63		@param listener
64			the listener which should be registered
65	 */
66	[oneway] void addRowSetListener([in]XRowSetListener listener );
67	//-------------------------------------------------------------------------
68
69	/** removes the specified listener.
70		@param listener
71			the listener which should be registered
72	 */
73	[oneway] void removeRowSetListener([in]XRowSetListener listener );
74};
75
76//=============================================================================
77
78}; }; }; };
79
80/*===========================================================================
81===========================================================================*/
82#endif
83