1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski #ifndef CACHEDROWSET_HXX
25*b1cdbd2cSJim Jagielski #define CACHEDROWSET_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski /** === begin UNO includes === **/
28*b1cdbd2cSJim Jagielski #include <com/sun/star/sdbc/XResultSet.hpp>
29*b1cdbd2cSJim Jagielski #include <com/sun/star/sdbc/XConnection.hpp>
30*b1cdbd2cSJim Jagielski /** === end UNO includes === **/
31*b1cdbd2cSJim Jagielski 
32*b1cdbd2cSJim Jagielski #include <comphelper/componentcontext.hxx>
33*b1cdbd2cSJim Jagielski #include <unotools/sharedunocomponent.hxx>
34*b1cdbd2cSJim Jagielski 
35*b1cdbd2cSJim Jagielski #include <memory>
36*b1cdbd2cSJim Jagielski 
37*b1cdbd2cSJim Jagielski //........................................................................
38*b1cdbd2cSJim Jagielski namespace frm
39*b1cdbd2cSJim Jagielski {
40*b1cdbd2cSJim Jagielski //........................................................................
41*b1cdbd2cSJim Jagielski 
42*b1cdbd2cSJim Jagielski     struct CachedRowSet_Data;
43*b1cdbd2cSJim Jagielski 	//====================================================================
44*b1cdbd2cSJim Jagielski 	//= CachedRowSet
45*b1cdbd2cSJim Jagielski 	//====================================================================
46*b1cdbd2cSJim Jagielski     /** caches a result set obtained from a SQL statement
47*b1cdbd2cSJim Jagielski     */
48*b1cdbd2cSJim Jagielski 	class CachedRowSet
49*b1cdbd2cSJim Jagielski 	{
50*b1cdbd2cSJim Jagielski     public:
51*b1cdbd2cSJim Jagielski         CachedRowSet( const ::comphelper::ComponentContext& _rContext );
52*b1cdbd2cSJim Jagielski         ~CachedRowSet();
53*b1cdbd2cSJim Jagielski 
54*b1cdbd2cSJim Jagielski     public:
55*b1cdbd2cSJim Jagielski         /** executes the statement
56*b1cdbd2cSJim Jagielski 
57*b1cdbd2cSJim Jagielski             @return
58*b1cdbd2cSJim Jagielski                 the result set produced by the statement. The caller takes ownership of the
59*b1cdbd2cSJim Jagielski                 given object.
60*b1cdbd2cSJim Jagielski 
61*b1cdbd2cSJim Jagielski             @throws ::com::sun::star::sdbc::SQLException
62*b1cdbd2cSJim Jagielski                 if such an exception is thrown when executing the statement
63*b1cdbd2cSJim Jagielski         */
64*b1cdbd2cSJim Jagielski         ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet >
65*b1cdbd2cSJim Jagielski                 execute();
66*b1cdbd2cSJim Jagielski 
67*b1cdbd2cSJim Jagielski         /// determines whether the row set properties are dirty, i.e. have changed since the last call to execute
68*b1cdbd2cSJim Jagielski         bool    isDirty() const;
69*b1cdbd2cSJim Jagielski 
70*b1cdbd2cSJim Jagielski         /// disposes the instance and frees all associated resources
71*b1cdbd2cSJim Jagielski         void    dispose();
72*b1cdbd2cSJim Jagielski 
73*b1cdbd2cSJim Jagielski         /** sets the command of a query as command to be executed
74*b1cdbd2cSJim Jagielski 
75*b1cdbd2cSJim Jagielski             A connection must have been set before.
76*b1cdbd2cSJim Jagielski 
77*b1cdbd2cSJim Jagielski             @throws Exception
78*b1cdbd2cSJim Jagielski         */
79*b1cdbd2cSJim Jagielski         void    setCommandFromQuery ( const ::rtl::OUString& _rQueryName );
80*b1cdbd2cSJim Jagielski 
81*b1cdbd2cSJim Jagielski         void    setCommand          ( const ::rtl::OUString& _rCommand );
82*b1cdbd2cSJim Jagielski         void    setEscapeProcessing ( const sal_Bool _bEscapeProcessing );
83*b1cdbd2cSJim Jagielski         void    setConnection       ( const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection );
84*b1cdbd2cSJim Jagielski 
85*b1cdbd2cSJim Jagielski     private:
86*b1cdbd2cSJim Jagielski         ::std::auto_ptr< CachedRowSet_Data >    m_pData;
87*b1cdbd2cSJim Jagielski 	};
88*b1cdbd2cSJim Jagielski 
89*b1cdbd2cSJim Jagielski //........................................................................
90*b1cdbd2cSJim Jagielski } // namespace frm
91*b1cdbd2cSJim Jagielski //........................................................................
92*b1cdbd2cSJim Jagielski 
93*b1cdbd2cSJim Jagielski #endif // CACHEDROWSET_HXX
94