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

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