xref: /aoo41x/main/offapi/com/sun/star/sdbcx/ResultSet.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_sdbcx_ResultSet_idl__
24#define __com_sun_star_sdbcx_ResultSet_idl__
25
26#ifndef __com_sun_star_sdbc_ResultSet_idl__
27#include <com/sun/star/sdbc/ResultSet.idl>
28#endif
29
30 module com {  module sun {  module star {  module sdbcx {
31
32 published interface XRowLocate;
33 published interface XDeleteRows;
34
35
36/** extends the SDBC ResultSet by the possibility of bookmark positioning, cancelling
37	the positioning, and updating of rows.
38 */
39published service ResultSet
40{
41	service com::sun::star::sdbc::ResultSet;
42
43
44	/** could be used for cancelling the execution of SQL statements if both
45 the DBMS and the driver support aborting of navigation commands.
46 The implementation is optional.
47	 */
48	[optional] interface com::sun::star::util::XCancellable;
49
50
51	/** is the interface for navigating on the result set by unique bookmarks.
52	 */
53	interface XRowLocate;
54
55
56	/** is the interface for deleting more than one row, identified by it's bookmark.
57			  The implementation is optional.
58	 */
59	[optional] interface XDeleteRows;
60
61
62	/** returns if the resultset supports bookmark navigation.
63	 */
64	[readonly, property] boolean IsBookmarkable;
65
66
67	/** returns whether the resultset supports updating of newly inserted rows.
68		This may not work, as the result set may contain automatic generated data
69		which is used as key information.
70	 */
71	[optional, readonly, property] boolean CanUpdateInsertedRows;
72};
73
74//=============================================================================
75
76}; }; }; };
77
78/*===========================================================================
79===========================================================================*/
80#endif
81