xref: /aoo42x/main/offapi/com/sun/star/sdbc/Connection.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_Connection_idl__
24#define __com_sun_star_sdbc_Connection_idl__
25
26#ifndef __com_sun_star_lang_XComponent_idl__
27#include <com/sun/star/lang/XComponent.idl>
28#endif
29
30 module com {  module sun {  module star {  module sdbc {
31
32 published interface XConnection;
33 published interface XWarningsSupplier;
34
35
36/** represents a connection (session) with a specific
37	database. Within the context of a Connection, SQL statements are
38	executed and results are returned.
39
40	<p>
41	A Connection's database is able to provide information
42	describing its tables, its supported SQL grammar, its stored
43	procedures, and the capabilities of this connection. This
44	information is obtained with the
45	<member scope="com::sun::star::sdbc">XConnection::getMetaData()</member>
46	method.
47	</p>
48	<p>
49	<b>
50	Note:
51	</b>
52	By default the Connection automatically commits
53	changes after executing each statement. If auto commit has been
54	disabled, an explicit commit must be done or database changes will
55	not be saved.
56
57	</p>
58	@see com::sun::star::sdbc::XStatement
59	@see com::sun::star::sdbc::XResultSet
60	@see com::sun::star::sdbc::XDatabaseMetaData
61 */
62published service Connection
63{
64
65	/** controls the closing of a connection.
66	 */
67	interface com::sun::star::lang::XComponent;
68
69
70	/** the main interface for interaction with a connection to a database.
71	 */
72	interface XConnection;
73
74
75	/** controls the chaining of warnings, which may occur on every call
76			 to the connected database. Chained warnings from previous calls will be
77			 cleared before processing a new call.
78	 */
79	interface XWarningsSupplier;
80};
81
82//=============================================================================
83
84}; }; }; };
85
86/*===========================================================================
87===========================================================================*/
88#endif
89