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