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

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