1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.wiki.workspacesmigrator.internal

File SearchSuggestCustomConfigDeleter.java

 

Code metrics

0
0
0
1
44
8
0
-
-
0
-

Classes

Class Line # Actions
SearchSuggestCustomConfigDeleter 35 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    package org.xwiki.wiki.workspacesmigrator.internal;
21   
22    import org.xwiki.component.annotation.Role;
23   
24    import com.xpn.xwiki.XWikiException;
25   
26    /**
27    * Component that remove SearchSuggestConfig objects that was previously added by WorkspaceManager.Install.
28    * If we don't remove them, it will cause a conflict in DW since we have added a new object in the standard
29    * distribution (see http://jira.xwiki.org/browse/XWIKI-9697).
30    *
31    * @since 5.3RC1
32    * @version $Id: 98af14b0d5c3f34c394bd04f6597b0ffdbdd057a $
33    */
34    @Role
 
35    public interface SearchSuggestCustomConfigDeleter
36    {
37    /**
38    * The WorkspaceManager.Install script has added a new XWiki.SearchSuggestSourceClass object that we need to remove.
39    *
40    * @param wikiId id of the wiki where the config should be removed
41    * @throws XWikiException if problem occurs
42    */
43    void deleteSearchSuggestCustomConfig(String wikiId) throws XWikiException;
44    }