org.exoplatform.commons.api.settings
Class SettingListener

java.lang.Object
  org.exoplatform.container.component.BaseComponentPlugin
      org.exoplatform.services.listener.Listener<SettingService,SettingData>
          org.exoplatform.commons.api.settings.SettingListener

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

public abstract class SettingListener
extends org.exoplatform.services.listener.Listener<SettingService,SettingData>

For each call of the SettingService API, it will trigger the event corresponding

Field Summary

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

SettingListener()

Method Summary

void	onEvent(org.exoplatform.services.listener.Event<SettingService,SettingData> event) Callback function when the setting service dispatches an event
abstract void	onRemoveContext(org.exoplatform.services.listener.Event<SettingService,SettingData> event) Callback function when all setting properties in a context are removed
abstract void	onRemoveKey(org.exoplatform.services.listener.Event<SettingService,SettingData> event) Callback function when a setting property is removed with a specified composite key(context,scope,key)
abstract void	onRemoveScope(org.exoplatform.services.listener.Event<SettingService,SettingData> event) Callback function when all setting properties in a scope are removed
abstract void	onSet(org.exoplatform.services.listener.Event<SettingService,SettingData> event) Callback function when a new setting property is saved.

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SettingListener

public SettingListener()

Method Detail

onSet

public abstract void onSet(org.exoplatform.services.listener.Event<SettingService,SettingData> event)

Callback function when a new setting property is saved.

Parameters:

event - event that the setting service dispatch when a new setting properties is saved successfully

onRemoveKey

public abstract void onRemoveKey(org.exoplatform.services.listener.Event<SettingService,SettingData> event)

Callback function when a setting property is removed with a specified composite key(context,scope,key)

Parameters:

event - event that the setting service dispatches when a new setting property is removed successfully

onRemoveScope

public abstract void onRemoveScope(org.exoplatform.services.listener.Event<SettingService,SettingData> event)

Callback function when all setting properties in a scope are removed

Parameters:

event - event that the setting service dispatches when all setting properties in a scope are removed successfully

onRemoveContext

public abstract void onRemoveContext(org.exoplatform.services.listener.Event<SettingService,SettingData> event)

Callback function when all setting properties in a context are removed

Parameters:

event - event that the setting service dispatches when all setting properties in a context are removed successfully

onEvent

public void onEvent(org.exoplatform.services.listener.Event<SettingService,SettingData> event)
             throws Exception

Callback function when the setting service dispatches an event

Specified by:

onEvent in class org.exoplatform.services.listener.Listener<SettingService,SettingData>

Parameters:

event - event that the setting service dispatches

Throws:

Exception