dbaccess/inc/IEnvironment.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: IEnvironment.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef DBAUI_IENVIRONMENT_HXX
  31 #define DBAUI_IENVIRONMENT_HXX
  32
  33 #include <com/sun/star/sdbc/SQLException.hpp>
  34
  35 #include <connectivity/standardsqlstate.hxx>
  36
  37 namespace dbtools
  38 {
  39     class SQLExceptionInfo;
  40 }
  41
  42 namespace dbaui
  43 {
  44     // interface class for a generell environment
  45     class IEnvironment
  46     {
  47     public:
  48         /** appends an error in the current environment.
  49         */
  50         virtual void appendError(
  51                         const ::rtl::OUString& _rErrorMessage,
  52                         const ::dbtools::StandardSQLState _eSQLState = ::dbtools::SQL_GENERAL_ERROR,
  53                         const sal_Int32 _nErrorCode = 1000
  54                      ) = 0;
  55
  56         /** clears the error state.
  57         */
  58         virtual void clearError() = 0;
  59
  60         /** @retrun
  61             returns <TRUE/> when an error was set otherwise <FALSE/>
  62         */
  63         virtual sal_Bool hasError() const = 0;
  64
  65         /** returns the current error
  66         */
  67         virtual const ::dbtools::SQLExceptionInfo& getError() const = 0;
  68
  69         /** displays the current error, or does nothing if there is no current error
  70         */
  71         virtual void displayError() = 0;
  72
  73         /** gives access to the currently used connection
  74             @return
  75                 the currently used connection.
  76         */
  77         virtual const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& getConnection() const = 0;
  78     };
  79 }
  80 #endif // DBAUI_IENVIRONMENT_HXX