|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.9.0) E15995-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPreferenceSet
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 . |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
putPreference(IPreferenceName name, IPreference<T> value) Associates the specified value with the given preference name. |
|
|
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 |
---|
INamespaceName getNamespaceName()
void setNamespaceName(INamespaceName namespaceName)
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()
namespaceName
- the namespace name to which this will be associated.IPropertySetDefinitionName getPropertySetDefinitionName()
void setPropertySetDefinitionName(IPropertySetDefinitionName propertySetDefinitionName)
propertySetDefinitionName
as the associated propertysetdefinition name.propertySetDefinitionName
- a propertysetdefinition name.java.lang.String name()
IPreferenceSetName getName()
void setName(IPreferenceSetName preferenceSetName)
preferenceSetName
for this.preferenceSetName
- a preference set name for this.IPropertySetName getPropertySetName()
void setPropertySetName(IPropertySetName propertySetName)
propertySetName
for this.propertySetName
- a property set name for this.java.lang.String getDescription()
void setDescription(java.lang.String desc)
desc
as a brief description for this.desc
- a brief description.java.io.Serializable get(IPreferenceName name)
name
if mapped, or null
if this preferenceset contains no mapping for the given preference name
.name
- a preference name.java.io.Serializable put(IPreferenceName key, java.io.Serializable value)
key
- preference name with which the specified value is to be associated.value
- value to be associated with specified key.<T extends java.io.Serializable> T get(IPreferenceName name, java.lang.Class<T> c)
null
if this preferenceset contains no mapping for the given preference name
.T
- type of a class.name
- a preference name.c
- the class to which the value is casted to.<T extends java.io.Serializable> T put(IPreferenceName key, T value, java.lang.Class<T> c)
put(IPreferenceName, java.io.Serializable)
except it returns previously mapped value as a type of the given class c.T
- type of a class.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.boolean containsKey(IPreferenceName key)
key
- proeprty name whose presence in this propertyset is to be tested.java.util.List<IPreference<java.io.Serializable>> getPreferences()
<T extends java.io.Serializable> IPreference<T> getPreference(IPreferenceName name)
T
- the preference value's type.name
- a preference's name<T extends java.io.Serializable> IPreference<T> putPreference(IPreferenceName name, IPreference<T> value)
T
- type for the valuename
- a preference name.value
- the preference to be associated with the given preference name.<T extends java.io.Serializable> IPreference<T> removePreference(IPreferenceName name)
T
- the preference value's type.name
- a preference namevoid iterate(IPredicate<IPreference> predicate)
IPredicate.apply(Object)
method for each preference found in this preferenceset.predicate
- a predicate object.
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.9.0) E15995-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |