Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
WikiComponentManager | 36 | 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.component.wiki; | |
21 | ||
22 | import org.xwiki.component.annotation.Role; | |
23 | import org.xwiki.model.reference.DocumentReference; | |
24 | ||
25 | /** | |
26 | * A WikiComponentManager is responsible for registering and unregistering components that are defined as wiki pages. | |
27 | * Each {@link WikiComponent} managed by such manager is associated to a {@link DocumentReference}. The | |
28 | * referred document contains XObjects that define the role, hint and behavior (method bodies) of the component. This | |
29 | * document may also define requirements (other components to be binded in the method bodies execution context) and | |
30 | * possible extra interfaces (for example to implement {@link org.xwiki.component.phase.Initializable}). | |
31 | * | |
32 | * @version $Id: c057025dcc724b1c47cab7c6fb3d2e5482214611 $ | |
33 | * @since 4.2M3 | |
34 | */ | |
35 | @Role | |
36 | public interface WikiComponentManager | |
37 | { | |
38 | /** | |
39 | * Registers the passed component against the underlying component repository. | |
40 | * | |
41 | * @param component the component to register | |
42 | * @throws WikiComponentException when failed to register the component against the CM | |
43 | */ | |
44 | void registerWikiComponent(WikiComponent component) throws WikiComponentException; | |
45 | ||
46 | /** | |
47 | * Unregisters the wiki component(s) associated with the passed reference. | |
48 | * | |
49 | * @param reference the reference to the document holding the component to unregister | |
50 | * @throws WikiComponentException when failed to unregister the component from the CM. | |
51 | */ | |
52 | void unregisterWikiComponents(DocumentReference reference) throws WikiComponentException; | |
53 | } |