org.exoplatform.forum.bbcode.api
Interface BBCodeService

All Known Implementing Classes:

BBCodeServiceImpl, MemoryBBCodeService

public interface BBCodeService

Main Facade for all BBCode related operations

Version:

$Revision$

Author:

Patrice Lamarque

Method Summary

void	delete(String bbcodeId) Delete an existing BBCode
BBCode	findById(String bbcodeId) Load a specific BBCode
List<String>	getActive() Retrieve BBCode IDs that are active
List<BBCode>	getAll() Retrieve all BBCodes
void	registerBBCodePlugin(BBCodePlugin plugin) Register a new BBCode plugin
void	save(List<BBCode> bbcodes) Save a list of BBCodes

Method Detail

registerBBCodePlugin

void registerBBCodePlugin(BBCodePlugin plugin)
                          throws Exception

Register a new BBCode plugin

Parameters:

plugin -

Throws:

Exception

save

void save(List<BBCode> bbcodes)
          throws Exception

Save a list of BBCodes

Parameters:

bbcodes - List of BBCodes to save

Throws:

Exception

getAll

List<BBCode> getAll()
                    throws Exception

Retrieve all BBCodes

Returns:

List of all registered BBCodes

Throws:

Exception

getActive

List<String> getActive()
                       throws Exception

Retrieve BBCode IDs that are active

Returns:

List of BBCOde IDs

Throws:

Exception

findById

BBCode findById(String bbcodeId)
                throws Exception

Load a specific BBCode

Parameters:

bbcodeId - ID of the BBCode

Returns:

Throws:

Exception

delete

void delete(String bbcodeId)
            throws Exception

Delete an existing BBCode

Parameters:

bbcodeId -

Throws:

Exception