Branch data Line data Source code
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 _DBAUI_INTERACTION_HXX_
21 : : #define _DBAUI_INTERACTION_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 dbtools
36 : : {
37 : : class SQLExceptionInfo;
38 : : }
39 : :
40 : : //.........................................................................
41 : : namespace dbaui
42 : : {
43 : : //.........................................................................
44 : :
45 : : //=========================================================================
46 : : //= BasicInteractionHandler
47 : : //=========================================================================
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 [ + - ][ - + ]: 4 : class BasicInteractionHandler
63 : : :public BasicInteractionHandler_Base
64 : : {
65 : : const OModuleClient m_aModuleClient;
66 : : const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
67 : : m_xORB;
68 : : const bool m_bFallbackToGeneric;
69 : :
70 : : public:
71 : : BasicInteractionHandler(
72 : : const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& i_rORB,
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);
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);
81 : :
82 : : protected:
83 : : sal_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 : : 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 : : 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 : : //=========================================================================
125 : : //= SQLExceptionInteractionHandler
126 : : //=========================================================================
127 [ # # ]: 0 : class SQLExceptionInteractionHandler : public BasicInteractionHandler
128 : : {
129 : : public:
130 : 0 : SQLExceptionInteractionHandler(
131 : : const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& i_rORB
132 : : )
133 : 0 : :BasicInteractionHandler( i_rORB, false )
134 : : {
135 : 0 : }
136 : :
137 : : // XServiceInfo
138 : : DECLARE_SERVICE_INFO_STATIC();
139 : : };
140 : :
141 : : //=========================================================================
142 : : //= SQLExceptionInteractionHandler
143 : : //=========================================================================
144 : : /** an implementation for the legacy css.sdb.InteractionHandler
145 : :
146 : : css.sdb.InteractionHandler is deprecated, as it does not only handle database related interactions,
147 : : but also delegates all kind of unknown requests to a css.task.InteractionHandler.
148 : :
149 : : In today's architecture, there's only one central css.task.InteractionHandler, which is to be used
150 : : for all requests. Depending on configuration information, it decides which handler implementation
151 : : to delegate a request to.
152 : :
153 : : SQLExceptionInteractionHandler is the delegatee which handles only database related interactions.
154 : : LegacyInteractionHandler is the version which first checks for a database related interaction, and
155 : : forwards everything else to the css.task.InteractionHandler.
156 : : */
157 [ - + ]: 8 : class LegacyInteractionHandler : public BasicInteractionHandler
158 : : {
159 : : public:
160 : 4 : LegacyInteractionHandler(
161 : : const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& i_rORB
162 : : )
163 : 4 : :BasicInteractionHandler( i_rORB, true )
164 : : {
165 : 4 : }
166 : :
167 : : // XServiceInfo
168 : : DECLARE_SERVICE_INFO_STATIC();
169 : : };
170 : :
171 : : //.........................................................................
172 : : } // namespace dbaui
173 : : //.........................................................................
174 : :
175 : : #endif // _DBAUI_INTERACTION_HXX_
176 : :
177 : : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
