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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_sdbc_XIsolatedConnection_idl__
  29 #define __com_sun_star_sdbc_XIsolatedConnection_idl__
  30
  31 #include <com/sun/star/task/XInteractionHandler.idl>
  32
  33 #include <com/sun/star/sdbc/SQLException.idl>
  34
  35  module com {  module sun {  module star {  module sdbc {
  36
  37  published interface XConnection;
  38 /** is used for establishing isolated connections via a factory.
  39     <p>
  40     The <type>XIsolatedConnection</type> allows to create connections which are not shared among others
  41     as it is the case when creating connections in normal way.
  42     </p>
  43     @see com::sun::star::sdb::DataSource
  44     @since OOo 1.1.2
  45  */
  46 published interface XIsolatedConnection: com::sun::star::uno::XInterface
  47 {
  48     /** attempts to establish a database connection.
  49         <p>If information is missing, such as
  50         a user's password, they are completed by user interaction.</p>
  51         @param handler
  52             The handler which ask for the needed information when they are missing.
  53         @returns
  54             A connection which is not shared.
  55         @throws com::sun::star::sdbc::SQLException
  56             when an error occurs.
  57      */
  58     XConnection
  59         getIsolatedConnectionWithCompletion([in]com::sun::star::task::XInteractionHandler handler)
  60              raises (SQLException);
  61
  62     /** attempts to establish a database connection.
  63         @param user
  64             The user name.
  65         @param password
  66             The password.
  67         @returns
  68             A connection which is not shared.
  69         @throws com::sun::star::sdbc::SQLException
  70             when an error occurs.
  71      */
  72     XConnection getIsolatedConnection([in]string user, [in]string password)
  73         raises (SQLException);
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 /*===========================================================================
  81 ===========================================================================*/
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */