offapi/com/sun/star/sdbc/ConnectionPool.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 #ifndef __com_sun_star_sdbc_ConnectionPool_idl__
  28 #define __com_sun_star_sdbc_ConnectionPool_idl__
  29
  30  module com {  module sun {  module star {  module sdbc {
  31
  32  published interface XDriverManager;
  33
  34
  35 /** is the basic service for pooling SDBC connections.
  36
  37     <p>
  38     When the method
  39     <member scope="com::sun::star::sdbc">XPooledConnection::getConnection()</member>
  40     is called,
  41     the ConnectionPool will attempt to locate a suitable pooled connection
  42     or create a new connection from the DriverManager. When the connection
  43     will be released it will move to the pool of unused connections.
  44
  45     </p>
  46     @see com::sun::star::sdbc::XDriver
  47     @see com::sun::star::sdbc::XConnection
  48  */
  49 published service ConnectionPool: XDriverManager;
  50
  51 //=============================================================================
  52
  53 }; }; }; };
  54
  55
  56 #endif
  57