1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef DBACCESS_MIGRATIONENGINE_HXX
29*cdf0e10cSrcweir #define DBACCESS_MIGRATIONENGINE_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir /** === begin UNO includes === **/
32*cdf0e10cSrcweir #include <com/sun/star/sdb/XOfficeDatabaseDocument.hpp>
33*cdf0e10cSrcweir /** === end UNO includes === **/
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir #include <comphelper/componentcontext.hxx>
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir #include <memory>
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir namespace comphelper {
40*cdf0e10cSrcweir     class ComponentContext;
41*cdf0e10cSrcweir }
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir //........................................................................
44*cdf0e10cSrcweir namespace dbmm
45*cdf0e10cSrcweir {
46*cdf0e10cSrcweir //........................................................................
47*cdf0e10cSrcweir 
48*cdf0e10cSrcweir     class IMigrationProgress;
49*cdf0e10cSrcweir     class MigrationLog;
50*cdf0e10cSrcweir 
51*cdf0e10cSrcweir     //====================================================================
52*cdf0e10cSrcweir 	//= MigrationEngine
53*cdf0e10cSrcweir 	//====================================================================
54*cdf0e10cSrcweir     class MigrationEngine_Impl;
55*cdf0e10cSrcweir 	class MigrationEngine
56*cdf0e10cSrcweir 	{
57*cdf0e10cSrcweir     public:
58*cdf0e10cSrcweir         /** creates the migration engine
59*cdf0e10cSrcweir             @param  _rxDocument
60*cdf0e10cSrcweir                 the document whose macros/scripts should be migrated
61*cdf0e10cSrcweir             @param  _rProgress
62*cdf0e10cSrcweir                 a callback for notifying progress. Beware of lifetimes here: The progress callback,
63*cdf0e10cSrcweir                 passed herein as reference, must live as long as the engine instance lives.
64*cdf0e10cSrcweir         */
65*cdf0e10cSrcweir         MigrationEngine(
66*cdf0e10cSrcweir             const ::comphelper::ComponentContext& _rContext,
67*cdf0e10cSrcweir             const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XOfficeDatabaseDocument >& _rxDocument,
68*cdf0e10cSrcweir             IMigrationProgress& _rProgress,
69*cdf0e10cSrcweir             MigrationLog& _rLogger
70*cdf0e10cSrcweir         );
71*cdf0e10cSrcweir 
72*cdf0e10cSrcweir         ~MigrationEngine();
73*cdf0e10cSrcweir 
74*cdf0e10cSrcweir         sal_Int32   getFormCount() const;
75*cdf0e10cSrcweir         sal_Int32   getReportCount() const;
76*cdf0e10cSrcweir 
77*cdf0e10cSrcweir         /** starts migrating the scripts and macros in the forms/reports to the database
78*cdf0e10cSrcweir             document.
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir             This process cannot be cancelled, as it would leave the document in an inconsistent
81*cdf0e10cSrcweir             state.
82*cdf0e10cSrcweir 
83*cdf0e10cSrcweir             When the function returns, then the migration is finished.
84*cdf0e10cSrcweir 
85*cdf0e10cSrcweir             @return
86*cdf0e10cSrcweir                 whether or not the migration was successful. If it wasn't, then an error has been reported
87*cdf0e10cSrcweir                 to the user, using the document's interaction handler. If no such interaction handler
88*cdf0e10cSrcweir                 was present, then the error has been silenced.
89*cdf0e10cSrcweir         */
90*cdf0e10cSrcweir         bool    migrateAll();
91*cdf0e10cSrcweir 
92*cdf0e10cSrcweir     private:
93*cdf0e10cSrcweir         ::std::auto_ptr< MigrationEngine_Impl > m_pImpl;
94*cdf0e10cSrcweir 	};
95*cdf0e10cSrcweir 
96*cdf0e10cSrcweir //........................................................................
97*cdf0e10cSrcweir } // namespace dbmm
98*cdf0e10cSrcweir //........................................................................
99*cdf0e10cSrcweir 
100*cdf0e10cSrcweir #endif // DBACCESS_MIGRATIONENGINE_HXX
101