dbexception.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_DBEXCEPTION_HXX
#define INCLUDED_CONNECTIVITY_DBEXCEPTION_HXX
 
#include <connectivity/standardsqlstate.hxx>
#include <connectivity/dbtoolsdllapi.hxx>
#include <com/sun/star/uno/Reference.hxx>
 
namespace com::sun::star
{
    namespace sdb
    {
        class SQLContext;
        struct SQLErrorEvent;
    }
    namespace sdbc
    {
        class SQLWarning;
        class SQLException;
    }
}
 
namespace dbtools
{
 
 
//= Special exception if cancel is pressed in DBA UI
 
enum OOoBaseErrorCode
{
    ParameterInteractionCancelled = 1
};
 
 
//= SQLExceptionInfo - encapsulating the type info of an SQLException-derived class
 
 
class OOO_DLLPUBLIC_DBTOOLS SQLExceptionInfo final
{
public:
    enum class TYPE { SQLException, SQLWarning, SQLContext, Undefined };
 
private:
    css::uno::Any  m_aContent;
    TYPE            m_eType;    // redundant (could be derived from m_aContent.getValueType())
 
public:
    SQLExceptionInfo();
    SQLExceptionInfo(const css::sdbc::SQLException& _rError);
    SQLExceptionInfo(const css::sdbc::SQLWarning& _rError);
    SQLExceptionInfo(const css::sdb::SQLContext& _rError);
 
    SQLExceptionInfo( const OUString& _rSimpleErrorMessage );
 
            // use for events got via XSQLErrorListener::errorOccured
    SQLExceptionInfo(const css::uno::Any& _rError);
            // use with the Reason member of an SQLErrorEvent or with NextElement of an SQLException
 
    void    prepend( const OUString& _rErrorMessage );
 
    void    append( TYPE _eType, const OUString& _rErrorMessage, const OUString& _rSQLState = OUString(), const sal_Int32 _nErrorCode = 0 );
 
    void    doThrow();
 
    SQLExceptionInfo& operator=(const css::sdbc::SQLException& _rError);
    SQLExceptionInfo& operator=(const css::sdbc::SQLWarning& _rError);
    SQLExceptionInfo& operator=(const css::sdb::SQLContext& _rError);
    SQLExceptionInfo& operator=(const css::sdb::SQLErrorEvent& _rErrorEvent);
    SQLExceptionInfo& operator=(const css::uno::Any& _rCaughtSQLException);
 
    bool        isKindOf(TYPE _eType) const;
        // not just a simple comparison ! e.g. getType() == SQL_CONTEXT implies isKindOf(SQL_EXCEPTION) == sal_True !
    bool        isValid() const { return m_eType != TYPE::Undefined; }
    TYPE        getType() const { return m_eType; }
 
    operator const css::sdbc::SQLException*    () const;
    operator const css::sdb::SQLContext*       () const;
 
    const css::uno::Any& get() const { return m_aContent; }
 
    void    clear()
    {
        m_aContent.clear();
        m_eType = TYPE::Undefined;
    }
 
    // create an exception
    static css::uno::Any createException(TYPE eType, const OUString& rErrorMessage, const OUString& rSQLState, const sal_Int32 nErrorCode);
 
    // find the end of the exception chain
    static css::sdbc::SQLException* getLastException(css::sdbc::SQLException* pLastException);
 
private:
    void implDetermineType();
};
 
 
//= SQLExceptionIteratorHelper - iterating through an SQLException chain
 
 
class OOO_DLLPUBLIC_DBTOOLS SQLExceptionIteratorHelper final
{
    const css::sdbc::SQLException* m_pCurrent;
    SQLExceptionInfo::TYPE                      m_eCurrentType;
 
public:
    SQLExceptionIteratorHelper( const css::sdbc::SQLException& _rChainStart );
 
    SQLExceptionIteratorHelper( const SQLExceptionInfo& _rErrorInfo );
 
    bool                                        hasMoreElements() const { return ( m_pCurrent != nullptr ); }
 
    void                                        current( SQLExceptionInfo& _out_rInfo ) const;
 
    const css::sdbc::SQLException* next();
 
    void                                        next( SQLExceptionInfo& _out_rInfo );
};
 
 
//= StandardExceptions
 
 
OOO_DLLPUBLIC_DBTOOLS OUString getStandardSQLState( StandardSQLState _eState );
 
 
OOO_DLLPUBLIC_DBTOOLS void throwFunctionNotSupportedSQLException(
        const OUString& _rFunctionName,
        const css::uno::Reference< css::uno::XInterface >& _rxContext
    );
 
OOO_DLLPUBLIC_DBTOOLS void throwFunctionNotSupportedRuntimeException(
        const OUString& _rFunctionName,
        const css::uno::Reference< css::uno::XInterface >& _rxContext
    );
 
OOO_DLLPUBLIC_DBTOOLS void throwFunctionSequenceException(
        const css::uno::Reference< css::uno::XInterface >& Context,
        const css::uno::Any& Next = css::uno::Any()
    );
 
 
OOO_DLLPUBLIC_DBTOOLS void throwInvalidIndexException(
        const css::uno::Reference< css::uno::XInterface >& Context,
        const css::uno::Any& Next = css::uno::Any()
    );
 
 
OOO_DLLPUBLIC_DBTOOLS void throwGenericSQLException(
        const OUString& _rMsg,
        const css::uno::Reference< css::uno::XInterface >& _rxSource
    );
 
 
OOO_DLLPUBLIC_DBTOOLS void throwGenericSQLException(
        const OUString& _rMsg,
        const css::uno::Reference< css::uno::XInterface >& _rxSource,
        const css::uno::Any& _rNextException
    );
 
 
OOO_DLLPUBLIC_DBTOOLS void throwFeatureNotImplementedSQLException(
        const OUString& _rFeatureName,
        const css::uno::Reference< css::uno::XInterface >& _rxContext,
        const css::uno::Any& _rNextException = css::uno::Any()
    );
 
OOO_DLLPUBLIC_DBTOOLS void throwFeatureNotImplementedRuntimeException(
        const OUString& _rFeatureName,
        const css::uno::Reference< css::uno::XInterface >& _rxContext
    );
 
OOO_DLLPUBLIC_DBTOOLS void throwInvalidColumnException(
        const OUString& _rColumnName,
        const css::uno::Reference< css::uno::XInterface >& _rxContext
    );
 
 
OOO_DLLPUBLIC_DBTOOLS void throwSQLException(
        const OUString& _rMessage,
        const OUString& _rSQLState,
        const css::uno::Reference< css::uno::XInterface >& _rxContext,
        const sal_Int32 _nErrorCode
    );
 
 
OOO_DLLPUBLIC_DBTOOLS void throwSQLException(
        const OUString& _rMessage,
        StandardSQLState _eSQLState,
        const css::uno::Reference< css::uno::XInterface >& _rxContext,
        const sal_Int32 _nErrorCode = 0
    );
 
 
}   // namespace dbtools
 
 
#endif // INCLUDED_CONNECTIVITY_DBEXCEPTION_HXX
 
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */