org.exoplatform.forum.bbcode.api

Interface BBCodeService

public interface BBCodeService

Main Facade for all BBCode related operations.

Version:

$Revision$

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(String bbcodeId) Deletes an existing BBCode.
org.exoplatform.forum.bbcode.api.BBCode	findById(String bbcodeId) Loads a BBCode by its given Id.
List<String>	getActive() Retrieves BBCode Ids that are active.
List<org.exoplatform.forum.bbcode.api.BBCode>	getAll() Retrieves all BBCodes.
List<org.exoplatform.forum.bbcode.api.BBCode>	getBBCodeActive() Gets all active BBCodes.
void	registerBBCodePlugin(org.exoplatform.forum.bbcode.spi.BBCodePlugin plugin) Registers a new BBCode plugin.
void	save(List<org.exoplatform.forum.bbcode.api.BBCode> bbcodes) Saves a list of BBCodes.

Method Detail

registerBBCodePlugin

void registerBBCodePlugin(org.exoplatform.forum.bbcode.spi.BBCodePlugin plugin)
                          throws Exception

Registers a new BBCode plugin.

Parameters:

plugin - The plugin to be registered.

Throws:

Exception

Level API:

Platform

save

void save(List<org.exoplatform.forum.bbcode.api.BBCode> bbcodes)
          throws Exception

Saves a list of BBCodes.

Parameters:

bbcodes - BBCodes to be saved.

Throws:

Exception

Level API:

Platform

getAll

List<org.exoplatform.forum.bbcode.api.BBCode> getAll()
                                                     throws Exception

Retrieves all BBCodes.

Returns:

BBCodes.

Throws:

Exception

Level API:

Platform

getActive

List<String> getActive()
                       throws Exception

Retrieves BBCode Ids that are active.

Returns:

BBCode Ids.

Throws:

Exception

Level API:

Platform

getBBCodeActive

List<org.exoplatform.forum.bbcode.api.BBCode> getBBCodeActive()
                                                              throws Exception

Gets all active BBCodes.

Returns:

BBCodes.

Throws:

Exception

findById

org.exoplatform.forum.bbcode.api.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

Level API:

Platform

delete

void delete(String bbcodeId)
            throws Exception

Deletes an existing BBCode.

Parameters:

bbcodeId - Id of the deleted BBCode.

Throws:

Exception

Level API:

Platform