Interface WikiManager


  • @Role
    public interface WikiManager
    Component to create and manage wikis.
    Since:
    5.3M2
    Version:
    $Id: 53848f6ab0df6b89616256d77d3c29894bf3b840 $
    • Method Detail

      • create

        WikiDescriptor create​(String wikiId,
                              String wikiAlias,
                              boolean failOnExist)
                       throws WikiManagerException
        Create a new wiki.
        Parameters:
        wikiId - Id of the new wiki
        wikiAlias - Default alias of the new wiki
        failOnExist - throw an exception if the wikiId already exists
        Returns:
        the descriptor of the created wiki
        Throws:
        WikiManagerException - if problems occur
      • create

        default WikiDescriptor create​(String wikiId,
                                      String wikiAlias,
                                      String ownerId,
                                      boolean failOnExist)
                               throws WikiManagerException
        Create a new wiki.
        Parameters:
        wikiId - Id of the new wiki
        wikiAlias - Default alias of the new wiki
        ownerId - the identifier of the owner of the wiki (generally a serialized user reference)
        failOnExist - throw an exception if the wikiId already exists
        Returns:
        the descriptor of the created wiki
        Throws:
        WikiManagerException - if problems occur
        Since:
        11.3, 10.11.8
      • copy

        WikiDescriptor copy​(String fromWikiId,
                            String newWikiId,
                            String newWikiAlias,
                            boolean copyHistory,
                            boolean copyRecycleBin,
                            boolean failOnExist)
                     throws WikiManagerException
        Copy a wiki.
        Parameters:
        fromWikiId - If of the wiki to copy
        newWikiId - Id of the new wiki
        newWikiAlias - Default alias of the new wiki
        copyHistory - decide if you want to copy the pages' history
        copyRecycleBin - decide if you want to copy the recycle bin content
        failOnExist - throw an exception if the wikiId already exists
        Returns:
        the descriptor of the created wiki
        Throws:
        WikiManagerException - if problems occur
      • idAvailable

        boolean idAvailable​(String wikiId)
                     throws WikiManagerException
        Check if the wikiId is valid and available (the name is not already taken for technical reasons).
        Parameters:
        wikiId - the Id to test
        Returns:
        true if the Id is valid and available
        Throws:
        WikiManagerException - if problems occur