Impressum XPooledConnection.idl

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

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

 published interface XConnection;

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

<!-- JRH: unclear meaning -->

    <p>
    PoolConnections are handled by the connection pool.
    </p>
    <p>
    When the method
    com::sun::star::sdbc::XPooledConnection::getConnection()
    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);
};


}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */