Interface WikiComponentBuilder


  • @Role
    public interface WikiComponentBuilder
    Allows to provide a list of documents holding one or more WikiComponent, and to build components from those documents.
    Since:
    4.2M3
    Version:
    $Id: 82eb18c9ad7516cd1570f76165acc775f5693880 $
    • Method Detail

      • getDocumentReferences

        List<DocumentReference> getDocumentReferences()
        Get the list of documents holding components.
        Returns:
        the list of documents holding components
      • buildComponents

        List<WikiComponent> buildComponents​(DocumentReference reference)
                                     throws WikiComponentException
        Build the components defined in a document XObjects. Being able to define more than one component in a document depends on the implementation. It is up to the implementation to determine if the last author of the document has the required permissions to register a component.
        Parameters:
        reference - the reference to the document that holds component definition objects
        Returns:
        the constructed component definition
        Throws:
        WikiComponentException - when the document contains invalid component definition(s)