Package org.xwiki.component.wiki
Interface WikiComponentManager
-
@Role public interface WikiComponentManager
A WikiComponentManager is responsible for registering and unregistering components that are defined as wiki pages. EachWikiComponent
managed by such manager is associated to aEntityReference
. The referred entity is or contains XObjects that define the role, hint and behavior (method bodies) of the component. This document may also define requirements (other components to be binded in the method bodies execution context) and possible extra interfaces (for example to implementInitializable
).- Since:
- 4.2M3
- Version:
- $Id: a203c1dd5ea4f57c4ff6c3dbd6b02b451cd22c24 $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
registerWikiComponent(WikiComponent component)
Registers the passed component against the underlying component repository.void
unregisterWikiComponents(DocumentReference reference)
Unregisters the wiki component(s) associated with the passed reference.default void
unregisterWikiComponents(EntityReference reference)
Just asunregisterWikiComponents(DocumentReference)
, unregisters the wiki component(s) associated with the passed reference.
-
-
-
Method Detail
-
registerWikiComponent
void registerWikiComponent(WikiComponent component) throws WikiComponentException
Registers the passed component against the underlying component repository.- Parameters:
component
- the component to register- Throws:
WikiComponentException
- when failed to register the component against the CM
-
unregisterWikiComponents
void unregisterWikiComponents(DocumentReference reference) throws WikiComponentException
Unregisters the wiki component(s) associated with the passed reference.- Parameters:
reference
- the reference to the document holding the component to unregister- Throws:
WikiComponentException
- when failed to unregister the component from the CM.
-
unregisterWikiComponents
default void unregisterWikiComponents(EntityReference reference) throws WikiComponentException
Just asunregisterWikiComponents(DocumentReference)
, unregisters the wiki component(s) associated with the passed reference.- Parameters:
reference
- the reference to the document holding the component to unregister- Throws:
WikiComponentException
- when failed to unregister the component from the CM.- Since:
- 9.5RC1
-
-