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 Summary

void	delete(String bbcodeId) Deletes an existing BBCode.
BBCode	findById(String bbcodeId) Loads a specific BBCode.
List<String>	getActive() Retrieves BBCode IDs that are active.
List<BBCode>	getAll() Retrieves all BBCodes.
List<BBCode>	getBBCodeActive()
void	registerBBCodePlugin(BBCodePlugin plugin) Registers a new BBCode plugin.
void	save(List<BBCode> bbcodes) Saves a list of BBCodes.

Method Detail

registerBBCodePlugin

void registerBBCodePlugin(BBCodePlugin plugin)
                          throws Exception

Registers a new BBCode plugin.

Parameters:

plugin -

Throws:

Exception

save

void save(List<BBCode> bbcodes)
          throws Exception

Saves a list of BBCodes.

Parameters:

bbcodes - List of BBCodes to save

Throws:

Exception

getAll

List<BBCode> getAll()
                    throws Exception

Retrieves all BBCodes.

Returns:

List of all registered BBCodes

Throws:

Exception

getActive

List<String> getActive()
                       throws Exception

Retrieves BBCode IDs that are active.

Returns:

List of BBCOde IDs

Throws:

Exception

getBBCodeActive

List<BBCode> getBBCodeActive()
                             throws Exception

Returns:

Throws:

Exception

findById

BBCode findById(String bbcodeId)
                throws Exception

Loads a specific BBCode.

Parameters:

bbcodeId - ID of the BBCode

Returns:

BBCode object of provided id.

Throws:

Exception

delete

void delete(String bbcodeId)
            throws Exception

Deletes an existing BBCode.

Parameters:

bbcodeId - the id of BBCode to be deleted

Throws:

Exception