xref: /trunk/main/connectivity/source/inc/AutoRetrievingBase.hxx (revision 914d351e5f5b84e4342a86d6ab8d4aca7308b9bd)
1*caf5cd79SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*caf5cd79SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*caf5cd79SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*caf5cd79SAndrew Rist  * distributed with this work for additional information
6*caf5cd79SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*caf5cd79SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*caf5cd79SAndrew Rist  * "License"); you may not use this file except in compliance
9*caf5cd79SAndrew Rist  * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir  *
11*caf5cd79SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir  *
13*caf5cd79SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*caf5cd79SAndrew Rist  * software distributed under the License is distributed on an
15*caf5cd79SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*caf5cd79SAndrew Rist  * KIND, either express or implied.  See the License for the
17*caf5cd79SAndrew Rist  * specific language governing permissions and limitations
18*caf5cd79SAndrew Rist  * under the License.
19cdf0e10cSrcweir  *
20*caf5cd79SAndrew Rist  *************************************************************/
21*caf5cd79SAndrew Rist 
22*caf5cd79SAndrew Rist 
23cdf0e10cSrcweir #ifndef _CONNECTIVITY_AUTOKEYRETRIEVINGBASE_HXX_
24cdf0e10cSrcweir #define _CONNECTIVITY_AUTOKEYRETRIEVINGBASE_HXX_
25cdf0e10cSrcweir 
26cdf0e10cSrcweir #include <rtl/ustring.hxx>
27cdf0e10cSrcweir #include "connectivity/dbtoolsdllapi.hxx"
28cdf0e10cSrcweir 
29cdf0e10cSrcweir namespace connectivity
30cdf0e10cSrcweir {
31cdf0e10cSrcweir     class OOO_DLLPUBLIC_DBTOOLS OAutoRetrievingBase
32cdf0e10cSrcweir     {
33cdf0e10cSrcweir         ::rtl::OUString m_sGeneratedValueStatement; // contains the statement which should be used when query for automatically generated values
34cdf0e10cSrcweir         sal_Bool        m_bAutoRetrievingEnabled; // set to when we should allow to query for generated values
35cdf0e10cSrcweir     protected:
OAutoRetrievingBase()36cdf0e10cSrcweir         OAutoRetrievingBase() : m_bAutoRetrievingEnabled(sal_False) {}
~OAutoRetrievingBase()37cdf0e10cSrcweir         virtual ~OAutoRetrievingBase(){}
38cdf0e10cSrcweir 
enableAutoRetrievingEnabled(sal_Bool _bAutoEnable)39cdf0e10cSrcweir         inline void enableAutoRetrievingEnabled(sal_Bool _bAutoEnable)          { m_bAutoRetrievingEnabled = _bAutoEnable; }
setAutoRetrievingStatement(const::rtl::OUString & _sStmt)40cdf0e10cSrcweir         inline void setAutoRetrievingStatement(const ::rtl::OUString& _sStmt)   { m_sGeneratedValueStatement = _sStmt; }
41cdf0e10cSrcweir     public:
isAutoRetrievingEnabled() const42cdf0e10cSrcweir         inline sal_Bool                 isAutoRetrievingEnabled()       const { return m_bAutoRetrievingEnabled; }
getAutoRetrievingStatement() const43cdf0e10cSrcweir         inline const ::rtl::OUString&   getAutoRetrievingStatement()    const { return m_sGeneratedValueStatement; }
44cdf0e10cSrcweir 
45cdf0e10cSrcweir         /** transform the statement to query for auto generated values
46cdf0e10cSrcweir             @param  _sInsertStatement
47cdf0e10cSrcweir                 The "INSERT" statement, is used to query for column and table names
48cdf0e10cSrcweir             @return
49cdf0e10cSrcweir                 The transformed generated statement.
50cdf0e10cSrcweir         */
51cdf0e10cSrcweir         ::rtl::OUString getTransformedGeneratedStatement(const ::rtl::OUString& _sInsertStatement) const;
52cdf0e10cSrcweir     };
53cdf0e10cSrcweir }
54cdf0e10cSrcweir #endif // _CONNECTIVITY_AUTOKEYRETRIEVINGBASE_HXX_
55