Package org.exoplatform.forum.bbcode.api

Interface BBCodeService

All Known Implementing Classes:
BBCodeServiceImpl, CachedBBCodeService
public interface BBCodeService
Main Facade for all BBCode related operations.
Version:
$Revision$

  • Method Details

    • registerBBCodePlugin

      void registerBBCodePlugin(BBCodePlugin plugin) throws Exception
      Registers a new BBCode plugin.
      Parameters:
      plugin - The plugin to be registered.
      Throws:
      Exception
      eXo level API
      Platform

    • save

      void save(List<BBCode> bbcodes) throws Exception
      Saves a list of BBCodes.
      Parameters:
      bbcodes - BBCodes to be saved.
      Throws:
      Exception
      eXo level API
      Platform

    • getAll

      List<BBCode> getAll() throws Exception
      Retrieves all BBCodes.
      Returns:
      BBCodes.
      Throws:
      Exception
      eXo level API
      Platform

    • getActive

      List<String> getActive() throws Exception
      Retrieves BBCode Ids that are active.
      Returns:
      BBCode Ids.
      Throws:
      Exception
      eXo level API
      Platform

    • getBBCodeActive

      List<BBCode> getBBCodeActive() throws Exception
      Gets all active BBCodes.
      Returns:
      BBCodes.
      Throws:
      Exception

    • findById

      BBCode findById(String bbcodeId) throws Exception
      Loads a BBCode by its given Id.
      Parameters:
      bbcodeId - Id of the loaded BBCode.
      Returns:
      The BBCode.
      Throws:
      Exception
      eXo level API
      Platform

    • delete

      void delete(String bbcodeId) throws Exception
      Deletes an existing BBCode.
      Parameters:
      bbcodeId - Id of the deleted BBCode.
      Throws:
      Exception
      eXo level API
      Platform