offapi/com/sun/star/sdbc/XPooledConnection.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
  20 #ifndef __com_sun_star_sdbc_XPooledConnection_idl__
  21 #define __com_sun_star_sdbc_XPooledConnection_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25 #include <com/sun/star/beans/PropertyValue.idl>
  26
  27 #include <com/sun/star/sdbc/SQLException.idl>
  28
  29  module com {  module sun {  module star {  module sdbc {
  30
  31  published interface XConnection;
  32
  33 /** defines a pooled connection which can share a unused connection.
  34
  35 <!-- JRH: unclear meaning -->
  36
  37     <p>
  38     PoolConnections are handled by the connection pool.
  39     </p>
  40     <p>
  41     When the method
  42     com::sun::star::sdbc::XPooledConnection::getConnection()
  43     is called, the PooledConnection returns the connection which is pooled.
  44     </p>
  45
  46     @see com::sun::star::sdbc::XConnection
  47  */
  48 published interface XPooledConnection: com::sun::star::uno::XInterface
  49 {
  50
  51     /** return the connection which is pooled
  52         @returns
  53             the pooled Connection object
  54         @throws SQLException
  55             if a database access error occurs.
  56      */
  57     XConnection getConnection()
  58         raises (SQLException);
  59 };
  60
  61
  62 }; }; }; };
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */