/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XPooledConnection.idl,v $
 * $Revision: 1.7 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sdbc_XPooledConnection_idl__
#define __com_sun_star_sdbc_XPooledConnection_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

#ifndef __com_sun_star_sdbc_SQLException_idl__
#include <com/sun/star/sdbc/SQLException.idl>
#endif

 module com {  module sun {  module star {  module sdbc {

 published interface XConnection;

/** defines a pooled connection which can share a unused connection.

<!-- JRH: unclear meaning -->

    <p>
    PoolConnections are handled by the connection pool.
    </p>
    <p>
    When the method
    <member scope="com::sun::star::sdbc">XPooledConnection::getConnection()</member>
    is called, the PooledConnection returns the connection which is pooled.
    </p>

    @see com::sun::star::sdbc::XConnection
 */
published interface XPooledConnection: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** return the connection which is pooled
        @returns
            the pooled Connection object
        @throws SQLException
            if a database access error occurs.
     */
    XConnection getConnection()
        raises (SQLException);
};

//=============================================================================

}; }; }; };

#endif