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