Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
WikiPropertyGroupProvider | 31 | 0 | - | 0 | 0 |
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.properties; | |
21 | ||
22 | import org.xwiki.component.annotation.Role; | |
23 | ||
24 | /** | |
25 | * Provider that manage WikiDescriptor Properties Groups. | |
26 | * | |
27 | * @version $Id: 745c020ca6de05a2e3376ab89c0701bdcfae8020 $ | |
28 | * @since 5.3M2 | |
29 | */ | |
30 | @Role | |
31 | public interface WikiPropertyGroupProvider | |
32 | { | |
33 | /** | |
34 | * Get the WikiDescriptor Property Group corresponding to a wiki. | |
35 | * | |
36 | * @param wikiId Id of the wiki | |
37 | * @return the group corresponding to the wiki | |
38 | * @throws WikiPropertyGroupException if problem occurs | |
39 | */ | |
40 | WikiPropertyGroup get(String wikiId) throws WikiPropertyGroupException; | |
41 | ||
42 | /** | |
43 | * Save the WikiDescriptor Property Group corresponding to a wiki in the persistent storage. | |
44 | * | |
45 | * @param group group to save | |
46 | * @param wikiId identifier of the wiki concerned by this group | |
47 | * @throws WikiPropertyGroupException if problem occurs | |
48 | */ | |
49 | void save(WikiPropertyGroup group, String wikiId) throws WikiPropertyGroupException; | |
50 | } |