xref: /aoo4110/main/offapi/com/sun/star/sdbc/XRowSet.idl (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski/**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdbc_XRowSet_idl__
24*b1cdbd2cSJim Jagielski#define __com_sun_star_sdbc_XRowSet_idl__
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdbc_XResultSet_idl__
27*b1cdbd2cSJim Jagielski#include <com/sun/star/sdbc/XResultSet.idl>
28*b1cdbd2cSJim Jagielski#endif
29*b1cdbd2cSJim Jagielski
30*b1cdbd2cSJim Jagielski module com {  module sun {  module star {  module sdbc {
31*b1cdbd2cSJim Jagielski
32*b1cdbd2cSJim Jagielski published interface XRowSetListener;
33*b1cdbd2cSJim Jagielski published interface XConnection;
34*b1cdbd2cSJim Jagielski
35*b1cdbd2cSJim Jagielski
36*b1cdbd2cSJim Jagielski/** enhances the functionality of a result set. It allows implementation of
37*b1cdbd2cSJim Jagielski	a special behavior for a result set and notifies an application on
38*b1cdbd2cSJim Jagielski	certain row set events such as a change in its value.
39*b1cdbd2cSJim Jagielski
40*b1cdbd2cSJim Jagielski
41*b1cdbd2cSJim Jagielski
42*b1cdbd2cSJim Jagielski	<p>
43*b1cdbd2cSJim Jagielski	The XRowSet interface is unique in that it is intended to be
44*b1cdbd2cSJim Jagielski	a software layer on top of an SDBC driver. Implementations of the
45*b1cdbd2cSJim Jagielski	RowSet interface can be provided by anyone.
46*b1cdbd2cSJim Jagielski	</p>
47*b1cdbd2cSJim Jagielski */
48*b1cdbd2cSJim Jagielskipublished interface XRowSet: XResultSet
49*b1cdbd2cSJim Jagielski{
50*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
51*b1cdbd2cSJim Jagielski
52*b1cdbd2cSJim Jagielski	/** populates a row set with data. The description of the data source and
53*b1cdbd2cSJim Jagielski		other important information for filling the row set with data.
54*b1cdbd2cSJim Jagielski
55*b1cdbd2cSJim Jagielski		@throws SQLException
56*b1cdbd2cSJim Jagielski			if a database access error occurs.
57*b1cdbd2cSJim Jagielski	 */
58*b1cdbd2cSJim Jagielski	void execute() raises (SQLException);
59*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
60*b1cdbd2cSJim Jagielski
61*b1cdbd2cSJim Jagielski	/** adds the specified listener to receive the events "cursorMoved",
62*b1cdbd2cSJim Jagielski		"rowChanged", and "rowSetChanged".
63*b1cdbd2cSJim Jagielski		@param listener
64*b1cdbd2cSJim Jagielski			the listener which should be registered
65*b1cdbd2cSJim Jagielski	 */
66*b1cdbd2cSJim Jagielski	[oneway] void addRowSetListener([in]XRowSetListener listener );
67*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
68*b1cdbd2cSJim Jagielski
69*b1cdbd2cSJim Jagielski	/** removes the specified listener.
70*b1cdbd2cSJim Jagielski		@param listener
71*b1cdbd2cSJim Jagielski			the listener which should be registered
72*b1cdbd2cSJim Jagielski	 */
73*b1cdbd2cSJim Jagielski	[oneway] void removeRowSetListener([in]XRowSetListener listener );
74*b1cdbd2cSJim Jagielski};
75*b1cdbd2cSJim Jagielski
76*b1cdbd2cSJim Jagielski//=============================================================================
77*b1cdbd2cSJim Jagielski
78*b1cdbd2cSJim Jagielski}; }; }; };
79*b1cdbd2cSJim Jagielski
80*b1cdbd2cSJim Jagielski/*===========================================================================
81*b1cdbd2cSJim Jagielski===========================================================================*/
82*b1cdbd2cSJim Jagielski#endif
83