summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdbc/Connection.idl
blob: d71e37e79f584e1e6bda999cf55e3dedb3ae160c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_sdbc_Connection_idl__
#define __com_sun_star_sdbc_Connection_idl__

#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif

 module com {  module sun {  module star {  module sdbc {

 published interface XConnection;
 published interface XWarningsSupplier;


/** represents a connection (session) with a specific
    database. Within the context of a Connection, SQL statements are
    executed and results are returned.

    <p>
    A Connection's database is able to provide information
    describing its tables, its supported SQL grammar, its stored
    procedures, and the capabilities of this connection. This
    information is obtained with the
    <member scope="com::sun::star::sdbc">XConnection::getMetaData()</member>
    method.
    </p>
    <p>
    <b>
    Note:
    </b>
    By default the Connection automatically commits
    changes after executing each statement. If auto commit has been
    disabled, an explicit commit must be done or database changes will
    not be saved.

    </p>
    @see com::sun::star::sdbc::XStatement
    @see com::sun::star::sdbc::XResultSet
    @see com::sun::star::sdbc::XDatabaseMetaData
 */
published service Connection
{

    /** controls the closing of a connection.
     */
    interface com::sun::star::lang::XComponent;


    /** the main interface for interaction with a connection to a database.
     */
    interface XConnection;


    /** controls the chaining of warnings, which may occur on every call
             to the connected database. Chained warnings from previous calls will be
             cleared before processing a new call.
     */
    interface XWarningsSupplier;
};

//=============================================================================

}; }; }; };

/*===========================================================================
===========================================================================*/
#endif