offapi/com/sun/star/sdbc/XIsolatedConnection.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 /** is used for establishing isolated connections via a factory.
  24     <p>
  25     The XIsolatedConnection allows to create connections which are not shared among others
  26     as it is the case when creating connections in normal way.
  27     </p>
  28     @see com::sun::star::sdb::DataSource
  29     @since OOo 1.1.2
  30  */
  31 published interface XIsolatedConnection: com::sun::star::uno::XInterface
  32 {
  33     /** attempts to establish a database connection.
  34         <p>If information is missing, such as
  35         a user's password, they are completed by user interaction.</p>
  36         @param handler
  37             The handler which ask for the needed information when they are missing.
  38         @returns
  39             A connection which is not shared.
  40         @throws com::sun::star::sdbc::SQLException
  41             when an error occurs.
  42      */
  43     XConnection
  44         getIsolatedConnectionWithCompletion([in]com::sun::star::task::XInteractionHandler handler)
  45              raises (SQLException);
  46
  47     /** attempts to establish a database connection.
  48         @param user
  49             The user name.
  50         @param password
  51             The password.
  52         @returns
  53             A connection which is not shared.
  54         @throws com::sun::star::sdbc::SQLException
  55             when an error occurs.
  56      */
  57     XConnection getIsolatedConnection([in]string user, [in]string password)
  58         raises (SQLException);
  59 };
  60
  61
  62 }; }; }; };
  63
  64 /*===========================================================================
  65 ===========================================================================*/
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */