offapi/com/sun/star/sdb/XCompletedConnection.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_sdb_XCompletedConnection_idl__
  28 #define __com_sun_star_sdb_XCompletedConnection_idl__
  29
  30 #ifndef __com_sun_star_task_XInteractionHandler_idl__
  31 #include <com/sun/star/task/XInteractionHandler.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_sdbc_SQLException_idl__
  35 #include <com/sun/star/sdbc/SQLException.idl>
  36 #endif
  37
  38  module com {  module sun {  module star {  module sdbc {
  39  published interface XConnection;
  40 };};};};
  41
  42  module com {  module sun {  module star {  module sdb {
  43
  44
  45 /** is used for establishing connections via a factory which is identified
  46     by it's name. To complete the information needed for establishing a connection
  47     an interaction handler is used.
  48  */
  49 published interface XCompletedConnection: com::sun::star::uno::XInterface
  50 {
  51
  52     /** attempts to establish a database connection. If information is missing, such as
  53         a user's password, they are completed by user interaction.
  54         @param handler
  55             will be asked when more information is needed
  56         @returns
  57             the Connection object
  58         @throws com::sun::star::sdbc::SQLException
  59             if a database access error occurs.
  60      */
  61     com::sun::star::sdbc::XConnection
  62         connectWithCompletion([in]com::sun::star::task::XInteractionHandler handler)
  63              raises (com::sun::star::sdbc::SQLException);
  64 };
  65
  66 //=============================================================================
  67
  68 }; }; }; };
  69
  70 /*===========================================================================
  71 ===========================================================================*/
  72 #endif