1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package com.xpn.xwiki.store.migration

File DataMigrationStatus.java

 

Code metrics

0
0
0
1
52
8
0
-
-
0
-

Classes

Class Line # Actions
DataMigrationStatus 29 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20   
21    package com.xpn.xwiki.store.migration;
22   
23    /**
24    * Common interface to report data migration status.
25    *
26    * @version $Id: 22cc507f7b3d445ccedee9d2d5da43b3825be6b2 $
27    * @since 4.4.1
28    */
 
29    public interface DataMigrationStatus
30    {
31    /**
32    * @return current DB version or null for a new database
33    * @xwiki.xwikicfg xwiki.store.migration.version - override data version
34    * @throws DataMigrationException if any error
35    */
36    XWikiDBVersion getDBVersion() throws DataMigrationException;
37   
38    /**
39    * @return true if any migration has been attempted on current database
40    */
41    boolean hasDataMigrationBeenAttempted();
42   
43    /**
44    * @return true if all attempted migrations has been successfully applied on current database
45    */
46    boolean hasBeenSuccessfullyMigrated();
47   
48    /**
49    * @return the exception returned on failure by the last attempted migration on this database
50    */
51    Exception getLastMigrationException();
52    }