dbaccess/source/ui/inc/datasourceconnector.hxx

   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: datasourceconnector.hxx,v $
  10  * $Revision: 1.8 $
  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
  31 #ifndef _DBAUI_DATASOURCECONNECTOR_HXX_
  32 #define _DBAUI_DATASOURCECONNECTOR_HXX_
  33
  34 #ifndef _COM_SUN_STAR_CONTAINER_XNAMEACCESS_HPP_
  35 #include <com/sun/star/container/XNameAccess.hpp>
  36 #endif
  37 #ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
  38 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  39 #endif
  40 #ifndef _COM_SUN_STAR_SDBC_XCONNECTION_HPP_
  41 #include <com/sun/star/sdbc/XConnection.hpp>
  42 #endif
  43 #ifndef _COM_SUN_STAR_SDBC_XDATASOURCE_HPP_
  44 #include <com/sun/star/sdbc/XDataSource.hpp>
  45 #endif
  46
  47 namespace dbtools
  48 {
  49     class SQLExceptionInfo;
  50 }
  51
  52 class Window;
  53 //.........................................................................
  54 namespace dbaui
  55 {
  56 //.........................................................................
  57
  58     //=====================================================================
  59     //= ODatasourceConnector
  60     //=====================================================================
  61     class ODatasourceConnector
  62     {
  63     protected:
  64         Window*                 m_pErrorMessageParent;
  65         ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
  66                         m_xORB;
  67         ::rtl::OUString m_sContextInformation;
  68
  69     public:
  70         ODatasourceConnector(
  71             const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB,
  72             Window* _pMessageParent
  73         );
  74         ODatasourceConnector(
  75             const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB,
  76             Window* _pMessageParent,
  77             const ::rtl::OUString& _rContextInformation
  78         );
  79
  80         /// returns <TRUE/> if the object is able to create data source connections
  81         sal_Bool        isValid() const { return m_xORB.is(); }
  82
  83         /** creates a connection to the data source, displays the possible error to the user, or returns it
  84         */
  85         ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >
  86                     connect(
  87                         const ::rtl::OUString& _rDataSourceName,
  88                         ::dbtools::SQLExceptionInfo* _pErrorInfo
  89                     ) const;
  90
  91         /** creates a connection to the data source, displays the possible error to the user, or returns it
  92         */
  93         ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >
  94                     connect(
  95                         const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDataSource>& _xDataSource,
  96                         ::dbtools::SQLExceptionInfo* _pErrorInfo
  97                     ) const;
  98     };
  99
 100 //.........................................................................
 101 }       // namespace dbaui
 102 //.........................................................................
 103
 104 #endif // _DBAUI_DATASOURCECONNECTOR_HXX_
 105