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