org.exoplatform.commons.api.settings.data
Class SettingData

java.lang.Object
  org.exoplatform.commons.api.settings.data.SettingData

public class SettingData
extends Object

Class support the setting event management, SettingData contains all information of event to listen.

Constructor Summary

SettingData(EventType eventType, SettingContext settingContext)
Create setting data with specified event type and context.

SettingData(EventType eventType, SettingContext settingContext, SettingValue<?> settingValue)
Create setting data with specified event type and setting property

Method Summary

EventType	getEventType() get event type associated to this setting data
SettingContext	getSettingContext() get setting context associated to this setting data
SettingValue<?>	getSettingValue() get setting value of setting property associated to this setting data, return null in case of context at level Context and Scope
void	setEventType(EventType eventType) set event type associated to this setting data
void	setSettingContext(SettingContext settingContext) set setting context associated to this setting data
void	setSettingValue(SettingValue<?> settingValue) set setting value of setting property (SettingKey) associated to this setting data

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingData

public SettingData(EventType eventType,
                   SettingContext settingContext)

Create setting data with specified event type and context. The context could be USER/GLOBAL context or a specified scope or a specified setting property.

Parameters:

eventType - event type has been dispatched

settingContext - setting context data information

SettingData

public SettingData(EventType eventType,
                   SettingContext settingContext,
                   SettingValue<?> settingValue)

Create setting data with specified event type and setting property

Parameters:

eventType - event type has been dispatched

settingContext - setting property's context

settingValue - setting property's value

Method Detail

getEventType

public EventType getEventType()

get event type associated to this setting data

Returns:

event type

setEventType

public void setEventType(EventType eventType)

set event type associated to this setting data

getSettingContext

public SettingContext getSettingContext()

get setting context associated to this setting data

Returns:

setting context

setSettingContext

public void setSettingContext(SettingContext settingContext)

set setting context associated to this setting data

getSettingValue

public SettingValue<?> getSettingValue()

get setting value of setting property associated to this setting data, return null in case of context at level Context and Scope

Returns:

setting value object, null if context at level Context and Scope

setSettingValue

public void setSettingValue(SettingValue<?> settingValue)

set setting value of setting property (SettingKey) associated to this setting data