offapi/com/sun/star/sdbc/Connection.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Connection.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdbc_Connection_idl__
  31 #define __com_sun_star_sdbc_Connection_idl__
  32
  33 #ifndef __com_sun_star_lang_XComponent_idl__
  34 #include <com/sun/star/lang/XComponent.idl>
  35 #endif
  36
  37  module com {  module sun {  module star {  module sdbc {
  38
  39  published interface XConnection;
  40  published interface XWarningsSupplier;
  41
  42
  43 /** represents a connection (session) with a specific
  44     database. Within the context of a Connection, SQL statements are
  45     executed and results are returned.
  46
  47     <p>
  48     A Connection's database is able to provide information
  49     describing its tables, its supported SQL grammar, its stored
  50     procedures, and the capabilities of this connection. This
  51     information is obtained with the
  52     <member scope="com::sun::star::sdbc">XConnection::getMetaData()</member>
  53     method.
  54     </p>
  55     <p>
  56     <b>
  57     Note:
  58     </b>
  59     By default the Connection automatically commits
  60     changes after executing each statement. If auto commit has been
  61     disabled, an explicit commit must be done or database changes will
  62     not be saved.
  63
  64     </p>
  65     @see com::sun::star::sdbc::XStatement
  66     @see com::sun::star::sdbc::XResultSet
  67     @see com::sun::star::sdbc::XDatabaseMetaData
  68  */
  69 published service Connection
  70 {
  71
  72     /** controls the closing of a connection.
  73      */
  74     interface com::sun::star::lang::XComponent;
  75
  76
  77     /** the main interface for interaction with a connection to a database.
  78      */
  79     interface XConnection;
  80
  81
  82     /** controls the chaining of warnings, which may occur on every call
  83              to the connected database. Chained warnings from previous calls will be
  84              cleared before processing a new call.
  85      */
  86     interface XWarningsSupplier;
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 /*===========================================================================
  94 ===========================================================================*/
  95 #endif