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