Interface WikiComponentManager


  • @Role
    public interface WikiComponentManager
    A WikiComponentManager is responsible for registering and unregistering components that are defined as wiki pages. Each WikiComponent managed by such manager is associated to a EntityReference. 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 implement Initializable).
    Since:
    4.2M3
    Version:
    $Id: a203c1dd5ea4f57c4ff6c3dbd6b02b451cd22c24 $
    • 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.