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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_sdbc_Connection_idl__
  20 #define __com_sun_star_sdbc_Connection_idl__
  21
  22 #include <com/sun/star/lang/XComponent.idl>
  23
  24  module com {  module sun {  module star {  module sdbc {
  25
  26  published interface XConnection;
  27  published interface XWarningsSupplier;
  28
  29
  30 /** represents a connection (session) with a specific
  31     database. Within the context of a Connection, SQL statements are
  32     executed and results are returned.
  33
  34     <p>
  35     A Connection's database is able to provide information
  36     describing its tables, its supported SQL grammar, its stored
  37     procedures, and the capabilities of this connection. This
  38     information is obtained with the
  39     com::sun::star::sdbc::XConnection::getMetaData()
  40     method.
  41     </p>
  42     <p>
  43     <b>
  44     Note:
  45     </b>
  46     By default the Connection automatically commits
  47     changes after executing each statement. If auto commit has been
  48     disabled, an explicit commit must be done or database changes will
  49     not be saved.
  50
  51     </p>
  52     @see com::sun::star::sdbc::XStatement
  53     @see com::sun::star::sdbc::XResultSet
  54     @see com::sun::star::sdbc::XDatabaseMetaData
  55  */
  56 published service Connection
  57 {
  58
  59     /** controls the closing of a connection.
  60      */
  61     interface com::sun::star::lang::XComponent;
  62
  63
  64     /** the main interface for interaction with a connection to a database.
  65      */
  66     interface XConnection;
  67
  68
  69     /** controls the chaining of warnings, which may occur on every call
  70              to the connected database. Chained warnings from previous calls will be
  71              cleared before processing a new call.
  72      */
  73     interface XWarningsSupplier;
  74 };
  75
  76
  77 }; }; }; };
  78
  79 /*===========================================================================
  80 ===========================================================================*/
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */