Skip navigation links

oracle.wcps.property
Interface IPreferenceSet

All Superinterfaces:

ITimestamped, java.util.Map<java.lang.String,java.io.Serializable>

All Known Implementing Classes:

PreferenceSet

public interface IPreferenceSet

extends ITimestamped, java.util.Map<java.lang.String,java.io.Serializable>

Represents a set of related preferences scoped to a property set IPropertySet and a currently logged in user.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

boolean	containsKey(IPreferenceName key) Returns true if this preferenceset contains a mapping for the specified property name key.
java.io.Serializable	get(IPreferenceName name) Returns the value associated with the given preference name if mapped, or null if this preferenceset contains no mapping for the given preference name.
<T extends java.io.Serializable> T	get(IPreferenceName name, java.lang.Class<T> c) Returns the value (casted to the given class c) associated with the given preference name if mapped or null if this preferenceset contains no mapping for the given preference name.
java.lang.String	getDescription() Returns a brief description of this.
IPreferenceSetName	getName() Returns name of this preference set.
INamespaceName	getNamespaceName() Returns the associated namespace name.
<T extends java.io.Serializable> IPreference<T>	getPreference(IPreferenceName name) Returns the preference with the given name if found otherwise null.
java.util.List<IPreference<java.io.Serializable>>	getPreferences() Returns the list of preferences of this preferenceset.
IPropertySetDefinitionName	getPropertySetDefinitionName() Returns the associated propertysetdefinition name.
IPropertySetName	getPropertySetName() Returns the propertyset name of this.
void	iterate(IPredicate<IPreference> predicate) Calls the given predicates IPredicate.apply(Object) method for each preference found in this preferenceset.
java.lang.String	name() Returns the string representation of the composite name of this.
java.io.Serializable	put(IPreferenceName key, java.io.Serializable value) Associates the specified value with the specified key in this preference set.
<T extends java.io.Serializable> T	put(IPreferenceName key, T value, java.lang.Class<T> c) Same as put(IPreferenceName, java.io.Serializable) except it returns previously mapped value as a type of the given class c.
<T extends java.io.Serializable> IPreference<T>	putPreference(IPreferenceName name, IPreference<T> value) Associates the specified value with the given preference name.
<T extends java.io.Serializable> IPreference<T>	removePreference(IPreferenceName name) Removes the preference associated with the given preference name.
void	setDescription(java.lang.String desc) Sets the given desc as a brief description for this.
void	setName(IPreferenceSetName preferenceSetName) Sets the given preferenceSetName for this.
void	setNamespaceName(INamespaceName namespaceName) Deprecated. it is a no op.
void	setPropertySetDefinitionName(IPropertySetDefinitionName propertySetDefinitionName) Sets the given propertySetDefinitionName as the associated propertysetdefinition name.
void	setPropertySetName(IPropertySetName propertySetName) Sets the given propertySetName for this.

Methods inherited from interface oracle.wcps.property.ITimestamped

getCreatedOn, getUpdatedOn, setCreatedOn, setUpdatedOn

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

getNamespaceName

INamespaceName getNamespaceName()

Returns the associated namespace name.

Returns:

the associated namespace name.

setNamespaceName

void setNamespaceName(INamespaceName namespaceName)

Deprecated. it is a no op.

Sets the given namespaceName as the associated namespace name. Note: Calling this has no effect when using methods of IPropertyService, its overridden with the namespace name in IPropertyService.getNamespaceName()

Parameters:

namespaceName - the namespace name to which this will be associated.

getPropertySetDefinitionName

IPropertySetDefinitionName getPropertySetDefinitionName()

Returns the associated propertysetdefinition name.

Returns:

the associated propertysetdefinition name.

setPropertySetDefinitionName

void setPropertySetDefinitionName(IPropertySetDefinitionName propertySetDefinitionName)

Sets the given propertySetDefinitionName as the associated propertysetdefinition name.

Parameters:

propertySetDefinitionName - a propertysetdefinition name.

name

java.lang.String name()

Returns the string representation of the composite name of this. It is created by combining "[string representation of the namespace name of this]: [string representation of the propertysetdefinition name of this]:[propertyset name]:[string representation of the name of this]".

Returns:

the string representation of the composite name.

getName

IPreferenceSetName getName()

Returns name of this preference set.

Returns:

the name of this.

setName

void setName(IPreferenceSetName preferenceSetName)

Sets the given preferenceSetName for this.

Parameters:

preferenceSetName - a preference set name for this.

getPropertySetName

IPropertySetName getPropertySetName()

Returns the propertyset name of this.

Returns:

the propertyset name of this.

setPropertySetName

void setPropertySetName(IPropertySetName propertySetName)

Sets the given propertySetName for this.

Parameters:

propertySetName - a property set name for this.

getDescription

java.lang.String getDescription()

Returns a brief description of this.

Returns:

a brief description.

setDescription

void setDescription(java.lang.String desc)

Sets the given desc as a brief description for this.

Parameters:

desc - a brief description.

get

java.io.Serializable get(IPreferenceName name)

Returns the value associated with the given preference name if mapped, or null if this preferenceset contains no mapping for the given preference name.

Parameters:

name - a preference name.

Returns:

the value for the given preference name if found otherwise null.

put

java.io.Serializable put(IPreferenceName key,
                         java.io.Serializable value)

Associates the specified value with the specified key in this preference set. If the preference set previously contained a mapping for the given key, the old value is replaced by the specified value.

Parameters:

key - preference name with which the specified value is to be associated.

value - value to be associated with specified key.

Returns:

the previous value associated with the key, or null if there was no mapping for key.

get

<T extends java.io.Serializable> T get(IPreferenceName name,
                                       java.lang.Class<T> c)

Returns the value (casted to the given class c) associated with the given preference name if mapped or null if this preferenceset contains no mapping for the given preference name.

Type Parameters:

T - type of a class.

Parameters:

name - a preference name.

c - the class to which the value is casted to.

Returns:

the mapped value if found otherwise null.

put

<T extends java.io.Serializable> T put(IPreferenceName key,
                                       T value,
                                       java.lang.Class<T> c)

Same as put(IPreferenceName, java.io.Serializable) except it returns previously mapped value as a type of the given class c.

Type Parameters:

T - type of a class.

Parameters:

key - preference name with which the specified value is to be associated.

value - value to be associated with specified key.

c - the class to which the previously mapped value is casted to.

Returns:

the previous value associated with the key, or null if there was no mapping for key.

containsKey

boolean containsKey(IPreferenceName key)

Returns true if this preferenceset contains a mapping for the specified property name key.

Parameters:

key - proeprty name whose presence in this propertyset is to be tested.

Returns:

true if this propertyset contains a mapping for the specified property name key

getPreferences

java.util.List<IPreference<java.io.Serializable>> getPreferences()

Returns the list of preferences of this preferenceset.

Returns:

a list of preferences.

getPreference

<T extends java.io.Serializable> IPreference<T> getPreference(IPreferenceName name)

Returns the preference with the given name if found otherwise null.

Type Parameters:

T - the preference value's type.

Parameters:

name - a preference's name

Returns:

the preference with the given name if found in this preferenceset, otherwise null.

putPreference

<T extends java.io.Serializable> IPreference<T> putPreference(IPreferenceName name,
                                                              IPreference<T> value)

Associates the specified value with the given preference name.

Type Parameters:

T - type for the value

Parameters:

name - a preference name.

value - the preference to be associated with the given preference name.

Returns:

the preference if mapped previously otherwise null.

removePreference

<T extends java.io.Serializable> IPreference<T> removePreference(IPreferenceName name)

Removes the preference associated with the given preference name.

Type Parameters:

T - the preference value's type.

Parameters:

name - a preference name

Returns:

the removed preference if the given name previously mapped otherwise null

iterate

void iterate(IPredicate<IPreference> predicate)

Calls the given predicates IPredicate.apply(Object) method for each preference found in this preferenceset.

Parameters:

predicate - a predicate object.

Skip navigation links