Package 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.
eXo level API
Experimental

  • Constructor Details

    • 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.
      eXo 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.
      eXo level API
      Experimental

  • Method Details

    • getEventType

      public EventType getEventType()
      Gets an event type associated with the setting data.
      Returns:
      The event type.
      eXo level API
      Experimental

    • setEventType

      public void setEventType(EventType eventType)
      Sets an event type associated with the setting data.
      eXo level API
      Experimental

    • getSettingContext

      public SettingContext getSettingContext()
      Gets a setting context associated with the setting data.
      Returns:
      The setting context.
      eXo level API
      Experimental

    • setSettingContext

      public void setSettingContext(SettingContext settingContext)
      Sets a setting context associated with the setting data.
      eXo 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.
      eXo level API
      Experimental

    • setSettingValue

      public void setSettingValue(SettingValue<?> settingValue)
      Sets a setting value of setting property (SettingKey) associated with the setting data.
      eXo level API
      Experimental