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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20  module com {  module sun {  module star {  module sdbc {
  21
  22  published interface XConnection;
  23
  24 /** defines a pooled connection which can share an unused connection.
  25
  26 <!-- JRH: unclear meaning -->
  27
  28     <p>
  29     PoolConnections are handled by the connection pool.
  30     </p>
  31     <p>
  32     When the method
  33     com::sun::star::sdbc::XPooledConnection::getConnection()
  34     is called, the PooledConnection returns the connection which is pooled.
  35     </p>
  36
  37     @see com::sun::star::sdbc::XConnection
  38  */
  39 published interface XPooledConnection: com::sun::star::uno::XInterface
  40 {
  41
  42     /** return the connection which is pooled
  43         @returns
  44             the pooled Connection object
  45         @throws SQLException
  46             if a database access error occurs.
  47      */
  48     XConnection getConnection()
  49         raises (SQLException);
  50 };
  51
  52
  53 }; }; }; };
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */