forms/source/component/cachedrowset.hxx

   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 INCLUDED_FORMS_SOURCE_COMPONENT_CACHEDROWSET_HXX
  21 #define INCLUDED_FORMS_SOURCE_COMPONENT_CACHEDROWSET_HXX
  22
  23 #include <com/sun/star/sdbc/XResultSet.hpp>
  24 #include <com/sun/star/sdbc/XConnection.hpp>
  25
  26 #include <unotools/sharedunocomponent.hxx>
  27
  28 #include <memory>
  29
  30
  31 namespace frm
  32 {
  33
  34     struct CachedRowSet_Data;
  35
  36     /// caches a result set obtained from a SQL statement
  37     class CachedRowSet
  38     {
  39     public:
  40         CachedRowSet();
  41         ~CachedRowSet();
  42
  43     public:
  44         /** executes the statement
  45
  46             @return
  47                 the result set produced by the statement. The caller takes ownership of the
  48                 given object.
  49
  50             @throws ::com::sun::star::sdbc::SQLException
  51                 if such an exception is thrown when executing the statement
  52         */
  53         ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet >
  54                 execute();
  55
  56         /// determines whether the row set properties are dirty, i.e. have changed since the last call to execute
  57         bool    isDirty() const;
  58
  59         /// disposes the instance and frees all associated resources
  60         void    dispose();
  61
  62         /** sets the command of a query as command to be executed
  63
  64             A connection must have been set before.
  65
  66             @throws Exception
  67         */
  68         void    setCommandFromQuery ( const OUString& _rQueryName );
  69
  70         void    setCommand          ( const OUString& _rCommand );
  71         void    setEscapeProcessing ( const bool _bEscapeProcessing );
  72         void    setConnection       ( const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection );
  73
  74     private:
  75         ::std::unique_ptr< CachedRowSet_Data >    m_pData;
  76     };
  77
  78
  79 } // namespace frm
  80
  81
  82 #endif // INCLUDED_FORMS_SOURCE_COMPONENT_CACHEDROWSET_HXX
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */