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:

Serialized Form

Level API:

Experimental

Field Summary

Fields

Modifier and Type	Field and Description
protected Scope	scope
protected String	scopePath

Fields inherited from class org.exoplatform.commons.api.settings.data.SettingContext

context, ContextPath, repositoryName

Constructor Summary

Constructors

Constructor and Description
SettingScope(Context context, Scope scope) Creates a setting scope object with a composite key [context, scope].

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Compares a specified object with the SettingScope for equality.
Scope	getScope() Gets a scope value of the SettingScope object.
String	getScopePath() Gets a path to the SettingScope object.
int	hashCode() Returns the hash code value for the SettingScope object.

Methods inherited from class org.exoplatform.commons.api.settings.data.SettingContext

getContext, getContextPath, getCurrentRepositoryName, getRepositoryName

Methods inherited from class java.lang.Object

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

Field Detail

scope

protected Scope scope

scopePath

protected String scopePath

Constructor Detail

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.

Level API:

Experimental

Method Detail

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.

Level API:

Experimental

getScopePath

public String getScopePath()

Gets a path to the SettingScope object.

Returns:

The SettingScope path in the database.

Level API:

Experimental