xref: /trunk/main/connectivity/source/inc/AutoRetrievingBase.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 #ifndef _CONNECTIVITY_AUTOKEYRETRIEVINGBASE_HXX_
28 #define _CONNECTIVITY_AUTOKEYRETRIEVINGBASE_HXX_
29 
30 #include <rtl/ustring.hxx>
31 #include "connectivity/dbtoolsdllapi.hxx"
32 
33 namespace connectivity
34 {
35     class OOO_DLLPUBLIC_DBTOOLS OAutoRetrievingBase
36     {
37         ::rtl::OUString m_sGeneratedValueStatement; // contains the statement which should be used when query for automatically generated values
38         sal_Bool        m_bAutoRetrievingEnabled; // set to when we should allow to query for generated values
39     protected:
40         OAutoRetrievingBase() : m_bAutoRetrievingEnabled(sal_False) {}
41         virtual ~OAutoRetrievingBase(){}
42 
43         inline void enableAutoRetrievingEnabled(sal_Bool _bAutoEnable)          { m_bAutoRetrievingEnabled = _bAutoEnable; }
44         inline void setAutoRetrievingStatement(const ::rtl::OUString& _sStmt)   { m_sGeneratedValueStatement = _sStmt; }
45     public:
46         inline sal_Bool                 isAutoRetrievingEnabled()       const { return m_bAutoRetrievingEnabled; }
47         inline const ::rtl::OUString&   getAutoRetrievingStatement()    const { return m_sGeneratedValueStatement; }
48 
49         /** transform the statement to query for auto generated values
50             @param  _sInsertStatement
51                 The "INSERT" statement, is used to query for column and table names
52             @return
53                 The transformed generated statement.
54         */
55         ::rtl::OUString getTransformedGeneratedStatement(const ::rtl::OUString& _sInsertStatement) const;
56     };
57 }
58 #endif // _CONNECTIVITY_AUTOKEYRETRIEVINGBASE_HXX_
59 
60