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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sdbc_XPooledConnection_idl__
  29 #define __com_sun_star_sdbc_XPooledConnection_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_beans_PropertyValue_idl__
  36 #include <com/sun/star/beans/PropertyValue.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_sdbc_SQLException_idl__
  40 #include <com/sun/star/sdbc/SQLException.idl>
  41 #endif
  42
  43  module com {  module sun {  module star {  module sdbc {
  44
  45  published interface XConnection;
  46
  47 /** defines a pooled connection which can share a unused connection.
  48
  49 <!-- JRH: unclear meaning -->
  50
  51     <p>
  52     PoolConnections are handled by the connection pool.
  53     </p>
  54     <p>
  55     When the method
  56     <member scope="com::sun::star::sdbc">XPooledConnection::getConnection()</member>
  57     is called, the PooledConnection returns the connection which is pooled.
  58     </p>
  59
  60     @see com::sun::star::sdbc::XConnection
  61  */
  62 published interface XPooledConnection: com::sun::star::uno::XInterface
  63 {
  64     //-------------------------------------------------------------------------
  65
  66     /** return the connection which is pooled
  67         @returns
  68             the pooled Connection object
  69         @throws SQLException
  70             if a database access error occurs.
  71      */
  72     XConnection getConnection()
  73         raises (SQLException);
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif