offapi/com/sun/star/sdbc/XPooledConnection.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: XPooledConnection.idl,v $
  10  * $Revision: 1.7 $
  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
  31 #ifndef __com_sun_star_sdbc_XPooledConnection_idl__
  32 #define __com_sun_star_sdbc_XPooledConnection_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_beans_PropertyValue_idl__
  39 #include <com/sun/star/beans/PropertyValue.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_sdbc_SQLException_idl__
  43 #include <com/sun/star/sdbc/SQLException.idl>
  44 #endif
  45
  46  module com {  module sun {  module star {  module sdbc {
  47
  48  published interface XConnection;
  49
  50 /** defines a pooled connection which can share a unused connection.
  51
  52 <!-- JRH: unclear meaning -->
  53
  54     <p>
  55     PoolConnections are handled by the connection pool.
  56     </p>
  57     <p>
  58     When the method
  59     <member scope="com::sun::star::sdbc">XPooledConnection::getConnection()</member>
  60     is called, the PooledConnection returns the connection which is pooled.
  61     </p>
  62
  63     @see com::sun::star::sdbc::XConnection
  64  */
  65 published interface XPooledConnection: com::sun::star::uno::XInterface
  66 {
  67     //-------------------------------------------------------------------------
  68
  69     /** return the connection which is pooled
  70         @returns
  71             the pooled Connection object
  72         @throws SQLException
  73             if a database access error occurs.
  74      */
  75     XConnection getConnection()
  76         raises (SQLException);
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 #endif