org.exoplatform.commons.api.settings.data

Class SettingData

java.lang.Object

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

public class SettingData
extends Object

Supports the setting event management that contains all information of event.

Level API:

Experimental

Constructor Summary

Constructors

Constructor and Description
SettingData(EventType eventType, SettingContext settingContext) Creates the setting data with the specified event type and context.
SettingData(EventType eventType, SettingContext settingContext, SettingValue<?> settingValue) Creates the setting data with the specified event type and setting properties.

Method Summary

Methods

Modifier and Type	Method and Description
EventType	getEventType() Gets an event type associated with the setting data.
SettingContext	getSettingContext() Gets a setting context associated with the setting data.
SettingValue<?>	getSettingValue() Gets a setting value of setting property associated with the setting data.
void	setEventType(EventType eventType) Sets an event type associated with the setting data.
void	setSettingContext(SettingContext settingContext) Sets a setting context associated with the setting data.
void	setSettingValue(SettingValue<?> settingValue) Sets a setting value of setting property (SettingKey) associated with the 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)

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

Parameters:

eventType - The event type that has been dispatched.

settingContext - The event setting context.

Level API:

Experimental

SettingData

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

Creates the setting data with the specified event type and setting properties.

Parameters:

eventType - The event type that has been dispatched.

settingContext - The event setting context.

settingValue - The event setting value.

Level API:

Experimental

Method Detail

getEventType

public EventType getEventType()

Gets an event type associated with the setting data.

Returns:

The event type.

Level API:

Experimental

setEventType

public void setEventType(EventType eventType)

Sets an event type associated with the setting data.

Level API:

Experimental

getSettingContext

public SettingContext getSettingContext()

Gets a setting context associated with the setting data.

Returns:

The setting context.

Level API:

Experimental

setSettingContext

public void setSettingContext(SettingContext settingContext)

Sets a setting context associated with the setting data.

Level API:

Experimental

getSettingValue

public SettingValue<?> getSettingValue()

Gets a setting value of setting property associated with the setting data.

Returns:

The setting value object, or "null" if context is at the Context or Scope level.

Level API:

Experimental

setSettingValue

public void setSettingValue(SettingValue<?> settingValue)

Sets a setting value of setting property (SettingKey) associated with the setting data.

Level API:

Experimental