1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_DBACCESS_SOURCE_UI_UNO_DBINTERACTION_HXX
#define INCLUDED_DBACCESS_SOURCE_UI_UNO_DBINTERACTION_HXX
#include <cppuhelper/implbase2.hxx>
#include "moduledbu.hxx"
#include "apitools.hxx"
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/task/XInteractionHandler2.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/ucb/AuthenticationRequest.hpp>
#include <com/sun/star/sdb/ParametersRequest.hpp>
#include <com/sun/star/sdb/DocumentSaveRequest.hpp>
namespace com { namespace sun { namespace star { namespace uno {
class XComponentContext;
} } } }
namespace dbtools
{
class SQLExceptionInfo;
}
namespace dbaui
{
// BasicInteractionHandler
typedef ::cppu::WeakImplHelper2 < ::com::sun::star::lang::XServiceInfo
, ::com::sun::star::task::XInteractionHandler2
> BasicInteractionHandler_Base;
/** implements an <type scope="com.sun.star.task">XInteractionHandler</type> for
database related interaction requests.
<p/>
Supported interaction requests by now (specified by an exception: The appropriate exception
has to be returned by the getRequest method of the object implementing the
<type scope="com.sun.star.task">XInteractionRequest</type> interface.
<ul>
<li><b><type scope="com.sun.star.sdbc">SQLException</type></b>: requests to display a
standard error dialog for the (maybe chained) exception given</li>
</ul>
*/
class BasicInteractionHandler
:public BasicInteractionHandler_Base
{
const OModuleClient m_aModuleClient;
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >
m_xContext;
const bool m_bFallbackToGeneric;
public:
BasicInteractionHandler(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext,
const bool i_bFallbackToGeneric
);
// XInitialization
void SAL_CALL initialize( com::sun::star::uno::Sequence< com::sun::star::uno::Any > const & /*rArguments*/) throw (com::sun::star::uno::Exception) {}
// XInteractionHandler2
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;
// XInteractionHandler
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;
protected:
bool
impl_handle_throw( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionRequest >& i_Request );
/// handle SQLExceptions (and derived classes)
void implHandle(
const ::dbtools::SQLExceptionInfo& _rSqlInfo,
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > >& _rContinuations);
/// handle parameter requests
void implHandle(
const ::com::sun::star::sdb::ParametersRequest& _rParamRequest,
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > >& _rContinuations);
/// handle document save requests
void implHandle(
const ::com::sun::star::sdb::DocumentSaveRequest& _rParamRequest,
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > >& _rContinuations);
/// handles requests which are not SDB-specific
bool implHandleUnknown(
const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionRequest >& _rxRequest );
/// known continuation types
enum Continuation
{
APPROVE,
DISAPPROVE,
RETRY,
ABORT,
SUPPLY_PARAMETERS,
SUPPLY_DOCUMENTSAVE
};
/** check if a given continuation sequence contains a given continuation type<p/>
@return the index within <arg>_rContinuations</arg> of the first occurrence of a continuation
of the requested type, -1 of no such continuation exists
*/
sal_Int32 getContinuation(
Continuation _eCont,
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > >& _rContinuations);
};
// SQLExceptionInteractionHandler
class SQLExceptionInteractionHandler : public BasicInteractionHandler
{
public:
SQLExceptionInteractionHandler(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext
)
:BasicInteractionHandler( rxContext, false )
{
}
// XServiceInfo
DECLARE_SERVICE_INFO_STATIC();
};
// SQLExceptionInteractionHandler
/** an implementation for the legacy css.sdb.InteractionHandler
css.sdb.InteractionHandler is deprecated, as it does not only handle database related interactions,
but also delegates all kind of unknown requests to a css.task.InteractionHandler.
In today's architecture, there's only one central css.task.InteractionHandler, which is to be used
for all requests. Depending on configuration information, it decides which handler implementation
to delegate a request to.
SQLExceptionInteractionHandler is the delegatee which handles only database related interactions.
LegacyInteractionHandler is the version which first checks for a database related interaction, and
forwards everything else to the css.task.InteractionHandler.
*/
class LegacyInteractionHandler : public BasicInteractionHandler
{
public:
LegacyInteractionHandler(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext
)
:BasicInteractionHandler( rxContext, true )
{
}
// XServiceInfo
DECLARE_SERVICE_INFO_STATIC();
};
} // namespace dbaui
#endif // INCLUDED_DBACCESS_SOURCE_UI_UNO_DBINTERACTION_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|