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

SettingScope is composed by [context,scope], associates with setting properties in a specified scope. Use SettingScope to specify context of setting properties in action with database, cache or in dispatching setting event.

See Also:

Serialized Form

Field Summary

protected Scope	scope
protected String	scopePath

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

context, ContextPath, repositoryName

Constructor Summary

SettingScope(Context context, Scope scope)
Create setting scope object with composite key [context,scope]

Method Summary

boolean	equals(Object obj)
Scope	getScope() get scope value of setting-scope
String	getScopePath() get path associated to this setting-scope
int	hashCode()

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)

Create setting scope object with composite key [context,scope]

Parameters:

context - context with which the specified value is to be associated

scope - scope with which the specified value is to be associated

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class SettingContext

hashCode

public int hashCode()

Overrides:

hashCode in class SettingContext

getScope

public Scope getScope()

get scope value of setting-scope

Returns:

value of key

getScopePath

public String getScopePath()

get path associated to this setting-scope

Returns:

path to setting data zone of this scope in the database