Package org.exoplatform.commons.api.settings.data

Class SettingScope

java.lang.Object
org.exoplatform.commons.api.settings.data.SettingContext
org.exoplatform.commons.api.settings.data.SettingScope
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
SettingKey
public class SettingScope extends SettingContext
Associates setting properties with a specified scope (for example, GLOBAL/PORTAL/APPLICATION). SettingScope is composed by [context, scope] and is used to specify context of setting properties at the Scope level when working with database, cache or dispatching the setting event.
See Also:
eXo level API
Experimental

  • Field Details

    • scope

      protected Scope scope

    • scopePath

      protected String scopePath

  • Constructor Details

    • SettingScope

      public SettingScope(Context context, Scope scope)
      Creates a setting scope object with a composite key [context, scope].
      Parameters:
      context - The context value.
      scope - The scope value.
      eXo level API
      Experimental

  • Method Details

    • equals

      public boolean equals(Object obj)
      Compares a specified object with the SettingScope for equality.
      Overrides:
      equals in class SettingContext

    • hashCode

      public int hashCode()
      Returns the hash code value for the SettingScope object.
      Overrides:
      hashCode in class SettingContext

    • getScope

      public Scope getScope()
      Gets a scope value of the SettingScope object.
      Returns:
      The value of key.
      eXo level API
      Experimental

    • getScopePath

      public String getScopePath()
      Gets a path to the SettingScope object.
      Returns:
      The SettingScope path in the database.
      eXo level API
      Experimental