sqlerror.hxx

Go to the documentation of this file.

/* -*- 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_CONNECTIVITY_SQLERROR_HXX
#define INCLUDED_CONNECTIVITY_SQLERROR_HXX
 
#include <com/sun/star/sdbc/SQLException.hpp>
#include <connectivity/dbtoolsdllapi.hxx>
#include <optional>
#include <memory>
 
namespace connectivity
{
 
 
    //= ErrorCondition
 
    typedef ::sal_Int32 ErrorCode;
 
    typedef ::sal_Int32 ErrorCondition;
 
 
    //= SQLError
 
    class SQLError_Impl;
 
    class OOO_DLLPUBLIC_DBTOOLS SQLError
    {
    public:
                        SQLError();
                        ~SQLError();
 
        OUString getErrorMessage(
                            const ErrorCondition _eCondition
                        ) const;
 
        static ErrorCode
                        getErrorCode( const ErrorCondition _eCondition );
 
        static const OUString&
                        getMessagePrefix();
 
 
        void            raiseException(
                            const ErrorCondition _eCondition,
                            const css::uno::Reference< css::uno::XInterface >& _rxContext,
                            const std::optional<OUString>& _rParamValue1 = std::nullopt,
                            const std::optional<OUString>& _rParamValue2 = std::nullopt,
                            const std::optional<OUString>& _rParamValue3 = std::nullopt
                        ) const;
 
        void            raiseException(
                            const ErrorCondition _eCondition
                        ) const;
 
        void            raiseTypedException(
                            const ErrorCondition _eCondition,
                            const css::uno::Reference< css::uno::XInterface >& _rxContext,
                            const css::uno::Type& _rExceptionType
                        ) const;
 
        css::sdbc::SQLException
                        getSQLException(
                            const ErrorCondition _eCondition,
                            const css::uno::Reference< css::uno::XInterface >& _rxContext,
                            const std::optional<OUString>& _rParamValue1 = std::nullopt,
                            const std::optional<OUString>& _rParamValue2 = std::nullopt,
                            const std::optional<OUString>& _rParamValue3 = std::nullopt
                        ) const;
 
    private:
        std::shared_ptr< SQLError_Impl > m_pImpl;
    };
 
 
} // namespace connectivity
 
 
#endif // INCLUDED_CONNECTIVITY_SQLERROR_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */