Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD com.ibm.policy.manager
Interface PolicyValueSet
- All Superinterfaces:
- java.util.Map
public interface PolicyValueSet- extends java.util.Map
PolicyValueSet (PVS) represents arbitrary name value pairs to be used by applications as points of variability. Within Policy, several characteristics of the true policy attributes are calculated at runtime, and are not part of the policy type definition. These characteristics include:
- inheritance
- inheritance locking
Additional settings and kinds of information are not limited to the confines of this interface and may be extended by implementing classes. The methods represented in this interface define the ones required for basic functionality within Policy Manager
- Since:
- 6.0.0
Nested Class Summary
Nested classes/interfaces inherited from interface java.util.Map java.util.Map.Entry<K,V>
Method Summary void clear()
Throws UnsupportedOperationException.boolean containsKey(java.lang.Object o)
Determines if the PVS contains the specified attributeboolean containsValue(java.lang.Object o)
Determines if the PVS contains the specified valuejava.util.Set entrySet()
Return a set view of the policy mappings contained in this map.boolean equals(java.lang.Object o)
Compares the specified object with this map for equality.java.lang.String getDisplayDescription(java.lang.Object attribute)
Retrieve unique key to be used to lookup the locale specific description of the attributejava.lang.String getDisplayName(java.lang.Object attribute)
Retrieve unique key to be used to lookup the locale specific name of the specified attributeMetaData getMetaData(java.lang.Object attribute)
Retrieve any associated MetaData for the specified attributejava.lang.String getPVSPath()
Retrieve unique Policy path to this nodejava.lang.String getPVSProfiler()
Retrieve the Personalization rule associated with this PVSboolean isAttributeInherited(java.lang.Object attributeKey)
Determine if the specified attribute is inherited or explicitly definedboolean isAttributeLocked(java.lang.Object attributeKey)
Determine if the specified attribute is locked.boolean isPolicyAttribute(java.lang.Object attributeKey)
PolicyValueSet maintains many characteristics not related to actual policy attributes and values, such as keys containing inheritance information.java.util.Set keySet()
PolicyValueSet interface maintains many artifacts not related to actual Policy attributes and values,such as keys containing inheritence information.java.lang.Object put(java.lang.Object key, java.lang.Object value)
Throws UnsupportedOperationException.void putAll(java.util.Map t)
Throws UnsupportedOperationException.java.lang.Object remove(java.lang.Object key)
Throws UnsupportedOperationException.int size()
Return the number of core policy key-value mappings in this map.java.util.Collection values()
Retrieve of all Policy Value attribute values
Methods inherited from interface java.util.Map get, hashCode, isEmpty
Method Detail getDisplayDescription
java.lang.String getDisplayDescription(java.lang.Object attribute)
- Retrieve unique key to be used to lookup the locale specific description of the attribute
- Parameters:
- attribute - attribute name
- Returns:
- unique String key
getDisplayName
java.lang.String getDisplayName(java.lang.Object attribute)
- Retrieve unique key to be used to lookup the locale specific name of the specified attribute
- Parameters:
- attribute - attribute name
- Returns:
- unique key to be used to lookup the locale specific name of the attribute
getPVSPath
java.lang.String getPVSPath()
- Retrieve unique Policy path to this node
- Returns:
- unique path to this PVS Node
getMetaData
MetaData getMetaData(java.lang.Object attribute)
- Retrieve any associated MetaData for the specified attribute
- Returns:
- MetaData associated with the supplied attribute
getPVSProfiler
java.lang.String getPVSProfiler()
- Retrieve the Personalization rule associated with this PVS
- Returns:
- the PZN profiler associated with this PVS
isAttributeInherited
boolean isAttributeInherited(java.lang.Object attributeKey)
- Determine if the specified attribute is inherited or explicitly defined
- Parameters:
- attributeKey - key to check
- Returns:
- true if the attribute value is inherited from a parent PVS, false otherwise
isAttributeLocked
boolean isAttributeLocked(java.lang.Object attributeKey)
- Determine if the specified attribute is locked. A locked attribute cannot be overridden by any sub-policies.
- Parameters:
- attributeKey - key to check
- Returns:
- true if the attribute value is inherited from a parent PVS, false otherwise
isPolicyAttribute
boolean isPolicyAttribute(java.lang.Object attributeKey)
- PolicyValueSet maintains many characteristics not related to actual policy attributes and values, such as keys containing inheritance information.
isPolicyAttribute() returns a true if the specified attribute is a core policy attribute, false if it is a calculated characteristic
- Parameters:
- attributeKey - attribute to check
- Returns:
- true if the specified attribute is an true policy attribute, false otherwise
keySet
java.util.Set keySet()
- PolicyValueSet interface maintains many artifacts not related to actual Policy attributes and values,such as keys containing inheritence information. This method returns a list of true policy attribute keys
- Specified by:
- keySet in interface java.util.Map
- Returns:
- Set of all the attributes' keys that are true policy attributes
containsKey
boolean containsKey(java.lang.Object o)
- Determines if the PVS contains the specified attribute
- Specified by:
- containsKey in interface java.util.Map
- Returns:
- true if the Policy Value Set contains the specified policy attribute, false otherwise
containsValue
boolean containsValue(java.lang.Object o)
- Determines if the PVS contains the specified value
- Specified by:
- containsValue in interface java.util.Map
- Returns:
- true if the Policy Value Set contains the specified policy value, false otherwise
values
java.util.Collection values()
- Retrieve of all Policy Value attribute values
- Specified by:
- values in interface java.util.Map
- Returns:
- Collection of all Policy Value attribute values
size
int size()
- Returns the number of core policy key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
- Specified by:
- size in interface java.util.Map
- Returns:
- the number of core policy key-value mappings in this map.
put
java.lang.Object put(java.lang.Object key, java.lang.Object value)
- Throws UnsupportedOperationException. PolicyValueSets are read only.
- Specified by:
- put in interface java.util.Map
- Throws:
- java.lang.UnsupportedOperationException
remove
java.lang.Object remove(java.lang.Object key)
- Throws UnsupportedOperationException. PolicyValueSets are read only.
- Specified by:
- remove in interface java.util.Map
- Throws:
- java.lang.UnsupportedOperationException
putAll
void putAll(java.util.Map t)
- Throws UnsupportedOperationException. PolicyValueSets are read only.
- Specified by:
- putAll in interface java.util.Map
- Throws:
- java.lang.UnsupportedOperationException
clear
void clear()
- Throws UnsupportedOperationException. PolicyValueSets are read only.
- Specified by:
- clear in interface java.util.Map
- Throws:
- java.lang.UnsupportedOperationException
entrySet
java.util.Set entrySet()
- Returns a set view of the policy mappings contained in this map. Each element in the returned set is a Map.Entry. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress, the results of the iteration are undefined. The set does NOT support element removal. PolicyValueSets are read only
- Specified by:
- entrySet in interface java.util.Map
- Returns:
- a set view of the mappings contained in this map.
equals
boolean equals(java.lang.Object o)
- Compares the specified object with this map for equality. Returns true if the given object is also a map and the two Maps represent the same policy mappings. Characteristics such as
are not used calculate equality
- inheritance
- blocked status
- policy path
- Specified by:
- equals in interface java.util.Map
- Overrides:
- equals in class java.lang.Object
- Parameters:
- o - object to be compared for equality with this map.
- Returns:
- true if the specified object is equal to this map.
Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD