org.exoplatform.commons.api.notification.service.setting

Interface PluginSettingService

public interface PluginSettingService

Method Summary

Modifier and Type	Method and Description
List<String>	getActivePluginIds(String channelId) Gets all Ids of active plugins by channel.
List<PluginInfo>	getActivePlugins(String channelId) Gets information of all active plugins by channel.
List<PluginInfo>	getAllPlugins() Gets information of all plugins.
List<GroupProvider>	getGroupPlugins() Gets a list of groups containing plugins.
PluginConfig	getPluginConfig(String pluginId) Gets configuration of a plugin from its Id.
boolean	isActive(String pluginId) Deprecated. user isActive(String channelId, String pluginId);
boolean	isActive(String channelId, String pluginId) Checks if a plugin is active or inactive.
void	registerGroupConfig(GroupProviderPlugin groupConfig) Registers the plugin configuration of a group.
void	registerPluginConfig(PluginConfig pluginConfig) Registers configuration of a plugin.
void	saveActive(String pluginId, boolean isActive) Deprecated. user isActive(String channelId, String pluginId);
void	saveActivePlugin(String channelId, String pluginId, boolean isActive) Saves a plugin.

Method Detail

registerPluginConfig

void registerPluginConfig(PluginConfig pluginConfig)

Registers configuration of a plugin.

Parameters:

pluginConfig - The plugin configuration.

registerGroupConfig

void registerGroupConfig(GroupProviderPlugin groupConfig)

Registers the plugin configuration of a group.

Parameters:

groupConfig - The plugin configuration to be registered.

getPluginConfig

PluginConfig getPluginConfig(String pluginId)

Gets configuration of a plugin from its Id.

Parameters:

pluginId - Id of the plugin.

Returns:

The plugin configuration.

getGroupPlugins

List<GroupProvider> getGroupPlugins()

Gets a list of groups containing plugins.

Returns:

The list of groups.

saveActivePlugin

void saveActivePlugin(String channelId,
                      String pluginId,
                      boolean isActive)

Saves a plugin.

Parameters:

pluginId - Id of the saved plugin.

isActive - If "true", the plugin is active. If "false", the plugin is inactive.

saveActive

void saveActive(String pluginId,
                boolean isActive)

Deprecated. user isActive(String channelId, String pluginId);

the channelId is email channel.

Parameters:

pluginId -

isActive -

isActive

boolean isActive(String channelId,
                 String pluginId)

Checks if a plugin is active or inactive.

Parameters:

pluginId - Id of the plugin.

Returns:

The returned value is "true" if the plugin is active or "false" if the plugin is inactive.

isActive

boolean isActive(String pluginId)

Deprecated. user isActive(String channelId, String pluginId);

the channelId is email channel.

Parameters:

pluginId -

Returns:

getActivePluginIds

List<String> getActivePluginIds(String channelId)

Gets all Ids of active plugins by channel.

Returns:

Ids of the active plugins.

getActivePlugins

List<PluginInfo> getActivePlugins(String channelId)

Gets information of all active plugins by channel.

Returns:

Information of the active plugins.

getAllPlugins

List<PluginInfo> getAllPlugins()

Gets information of all plugins.

Returns:

Information of the plugins.