Package org.exoplatform.wiki.service

Interface WikiService

All Known Implementing Classes:
WikiServiceImpl
public interface WikiService
Provides functions for processing database with wikis and pages, including: adding, editing, removing and searching for data.
eXo level API
Provisional

  • Method Details

    • getWikiPageParams

      WikiPageParams getWikiPageParams(BreadcrumbData data) throws WikiException
      Gets parameters of a wiki page based on the data stored in the breadcrumb.
      Parameters:
      data - The data in the breadcrumb that identifies the wiki page.
      Returns:
      The parameters identifying the wiki page.
      Throws:
      WikiException - if an error occured if an error occured

    • getDefaultWikiSyntaxId

      String getDefaultWikiSyntaxId()
      Gets Id of a default Wiki syntax.
      Returns:
      The Id.

    • addComponentPlugin

      void addComponentPlugin(org.exoplatform.container.component.ComponentPlugin plugin)
      Registers a component plugin into the Wiki service.
      Parameters:
      plugin - The component plugin to be registered.

    • getPageListeners

      List<PageWikiListener> getPageListeners()
      Gets listeners of all wiki pages that are registered into the Wiki service.
      Returns:
      The list of listeners.

    • getOrCreateUserWiki

      Wiki getOrCreateUserWiki(String username) throws WikiException
      Gets a user Wiki. If it does not exist, the new one will be created.
      Parameters:
      username - Name of the user.
      Returns:
      The user Wiki.
      Throws:
      WikiException - if an error occured

    • getSpaceNameByGroupId

      String getSpaceNameByGroupId(String groupId)
      Gets a space name by a given group Id.
      Parameters:
      groupId - The group Id.
      Returns:
      The space name.

    • getWikiByTypeAndOwner

      Wiki getWikiByTypeAndOwner(String wikiType, String owner) throws WikiException
      Gets a Wiki which is defined by its type and owner.
      Parameters:
      wikiType - It can be Portal, Group, or User.
      owner - The Wiki owner.
      Returns:
      The Wiki.
      Throws:
      WikiException - if an error occured

    • getWikisByType

      List<Wiki> getWikisByType(String wikiType) throws WikiException
      Gets all wikis of the given type
      Parameters:
      wikiType - Type of wiki
      Returns:
      Wikis of the given type
      Throws:
      WikiException - if an error occured

    • createWiki

      Wiki createWiki(String wikiType, String owner) throws WikiException
      Creates a wiki with the given type and owner
      Parameters:
      wikiType - It can be Portal, Group, or User.
      owner - The Wiki owner.
      Returns:
      Wiki created
      Throws:
      WikiException - if an error occured

    • getWikiWebappUri

      String getWikiWebappUri()
      Gets a Wiki webapp URI.
      Returns:
      The Wiki webapp URI.

    • getWikiById

      Wiki getWikiById(String wikiId) throws WikiException
      Gets a Wiki by its Id.
      Parameters:
      wikiId - The Wiki Id.
      Returns:
      The Wiki.
      Throws:
      WikiException - if an error occured

    • canManageWiki

      boolean canManageWiki(String wikiType, String wikiOwner, String username)
      Checks whether a user can manage a Wiki or not
      Parameters:
      wikiType - WikiType name
      wikiOwner - Wiki owner
      username - User login
      Returns:
      true if can manage wiki and its notes, else false