xref: /aoo41x/main/offapi/com/sun/star/sdbc/XRowSet.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_sdbc_XRowSet_idl__
28#define __com_sun_star_sdbc_XRowSet_idl__
29
30#ifndef __com_sun_star_sdbc_XResultSet_idl__
31#include <com/sun/star/sdbc/XResultSet.idl>
32#endif
33
34 module com {  module sun {  module star {  module sdbc {
35
36 published interface XRowSetListener;
37 published interface XConnection;
38
39
40/** enhances the functionality of a result set. It allows implementation of
41	a special behavior for a result set and notifies an application on
42	certain row set events such as a change in its value.
43
44
45
46	<p>
47	The XRowSet interface is unique in that it is intended to be
48	a software layer on top of an SDBC driver. Implementations of the
49	RowSet interface can be provided by anyone.
50	</p>
51 */
52published interface XRowSet: XResultSet
53{
54	//-------------------------------------------------------------------------
55
56	/** populates a row set with data. The description of the data source and
57		other important information for filling the row set with data.
58
59		@throws SQLException
60			if a database access error occurs.
61	 */
62	void execute() raises (SQLException);
63	//-------------------------------------------------------------------------
64
65	/** adds the specified listener to receive the events "cursorMoved",
66		"rowChanged", and "rowSetChanged".
67		@param listener
68			the listener which should be registered
69	 */
70	[oneway] void addRowSetListener([in]XRowSetListener listener );
71	//-------------------------------------------------------------------------
72
73	/** removes the specified listener.
74		@param listener
75			the listener which should be registered
76	 */
77	[oneway] void removeRowSetListener([in]XRowSetListener listener );
78};
79
80//=============================================================================
81
82}; }; }; };
83
84/*===========================================================================
85===========================================================================*/
86#endif
87