dbaccess/source/ui/uno/dbinteraction.hxx

   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
  20 #ifndef INCLUDED_DBACCESS_SOURCE_UI_UNO_DBINTERACTION_HXX
  21 #define INCLUDED_DBACCESS_SOURCE_UI_UNO_DBINTERACTION_HXX
  22
  23 #include <cppuhelper/implbase2.hxx>
  24
  25 #include "moduledbu.hxx"
  26 #include "apitools.hxx"
  27
  28 #include <com/sun/star/lang/XServiceInfo.hpp>
  29 #include <com/sun/star/task/XInteractionHandler2.hpp>
  30 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  31 #include <com/sun/star/ucb/AuthenticationRequest.hpp>
  32 #include <com/sun/star/sdb/ParametersRequest.hpp>
  33 #include <com/sun/star/sdb/DocumentSaveRequest.hpp>
  34
  35 namespace com { namespace sun { namespace star { namespace uno {
  36     class XComponentContext;
  37 } } } }
  38
  39 namespace dbtools
  40 {
  41     class SQLExceptionInfo;
  42 }
  43
  44 namespace dbaui
  45 {
  46
  47     // BasicInteractionHandler
  48     typedef ::cppu::WeakImplHelper2 <   ::com::sun::star::lang::XServiceInfo
  49                                     ,   ::com::sun::star::task::XInteractionHandler2
  50                                     >   BasicInteractionHandler_Base;
  51     /** implements an <type scope="com.sun.star.task">XInteractionHandler</type> for
  52         database related interaction requests.
  53         <p/>
  54         Supported interaction requests by now (specified by an exception: The appropriate exception
  55         has to be returned by the getRequest method of the object implementing the
  56         <type scope="com.sun.star.task">XInteractionRequest</type> interface.
  57             <ul>
  58                 <li><b><type scope="com.sun.star.sdbc">SQLException</type></b>: requests to display a
  59                     standard error dialog for the (maybe chained) exception given</li>
  60             </ul>
  61     */
  62     class BasicInteractionHandler
  63                 :public BasicInteractionHandler_Base
  64     {
  65         const OModuleClient m_aModuleClient;
  66         const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >
  67                             m_xContext;
  68         const bool          m_bFallbackToGeneric;
  69
  70     public:
  71         BasicInteractionHandler(
  72             const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext,
  73             const bool i_bFallbackToGeneric
  74         );
  75
  76         // XInteractionHandler2
  77         virtual sal_Bool SAL_CALL handleInteractionRequest( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionRequest >& Request ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  78
  79         // XInteractionHandler
  80         virtual void SAL_CALL handle( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionRequest >& Request ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  81
  82     protected:
  83         bool
  84                 impl_handle_throw( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionRequest >& i_Request );
  85
  86         /// handle SQLExceptions (and derived classes)
  87         static void implHandle(
  88                     const ::dbtools::SQLExceptionInfo& _rSqlInfo,
  89                     const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > >& _rContinuations);
  90
  91         /// handle parameter requests
  92         void    implHandle(
  93                     const ::com::sun::star::sdb::ParametersRequest& _rParamRequest,
  94                     const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > >& _rContinuations);
  95
  96         /// handle document save requests
  97         void    implHandle(
  98                     const ::com::sun::star::sdb::DocumentSaveRequest& _rParamRequest,
  99                     const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > >& _rContinuations);
 100
 101         /// handles requests which are not SDB-specific
 102         bool    implHandleUnknown(
 103                     const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionRequest >& _rxRequest );
 104
 105         /// known continuation types
 106         enum Continuation
 107         {
 108             APPROVE,
 109             DISAPPROVE,
 110             RETRY,
 111             ABORT,
 112             SUPPLY_PARAMETERS,
 113             SUPPLY_DOCUMENTSAVE
 114         };
 115         /** check if a given continuation sequence contains a given continuation type<p/>
 116             @return     the index within <arg>_rContinuations</arg> of the first occurrence of a continuation
 117                         of the requested type, -1 of no such continuation exists
 118         */
 119         static sal_Int32 getContinuation(
 120             Continuation _eCont,
 121             const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > >& _rContinuations);
 122     };
 123
 124     // SQLExceptionInteractionHandler
 125     class SQLExceptionInteractionHandler : public BasicInteractionHandler
 126     {
 127     public:
 128         SQLExceptionInteractionHandler(
 129                 const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext
 130             )
 131             :BasicInteractionHandler( rxContext, false )
 132         {
 133         }
 134
 135         // XServiceInfo
 136         DECLARE_SERVICE_INFO_STATIC();
 137     };
 138
 139     // SQLExceptionInteractionHandler
 140     /** an implementation for the legacy css.sdb.InteractionHandler
 141
 142         css.sdb.InteractionHandler is deprecated, as it does not only handle database related interactions,
 143         but also delegates all kind of unknown requests to a css.task.InteractionHandler.
 144
 145         In today's architecture, there's only one central css.task.InteractionHandler, which is to be used
 146         for all requests. Depending on configuration information, it decides which handler implementation
 147         to delegate a request to.
 148
 149         SQLExceptionInteractionHandler is the delegatee which handles only database related interactions.
 150         LegacyInteractionHandler is the version which first checks for a database related interaction, and
 151         forwards everything else to the css.task.InteractionHandler.
 152     */
 153     class LegacyInteractionHandler : public BasicInteractionHandler
 154     {
 155     public:
 156         LegacyInteractionHandler(
 157                 const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext
 158             )
 159             :BasicInteractionHandler( rxContext, true )
 160         {
 161         }
 162
 163         // XServiceInfo
 164         DECLARE_SERVICE_INFO_STATIC();
 165     };
 166
 167 }   // namespace dbaui
 168
 169 #endif // INCLUDED_DBACCESS_SOURCE_UI_UNO_DBINTERACTION_HXX
 170
 171 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */