com.sapportals.wcm.repository

Interface IPropertyMap

All Known Subinterfaces:

IMutablePropertyMap

All Known Implementing Classes:

MutablePropertyMap, PropertyMap

public interface IPropertyMap

A read-only map of properties.

Method Summary

boolean	containsProperty(IProperty property) Returns true if the map contains the specified property.
boolean	containsProperty(IPropertyName propertyName) Returns true if the map contains a property with the specified name.
IProperty	get(IPropertyName propertyName) Returns the property with the specified name or null if there is no such property.
Exception	getException(IPropertyName propertyName) Given a property that does not appear in the property map, query for a possible exception that occured internally when computing it.
Map	getExceptions() Returns a map from IPropertyNames to Exceptions for every property for which an internal error occured during retrieval (not being defined is not an error condition).
IMutablePropertyMap	getMutable() Returns a copy of the map that can be modified.
boolean	isEmpty() Returns true if the map is empty.
IPropertyIterator	iterator() Returns an iterator for the property map.
int	size() Returns the number of properties in the map.

Method Detail

size

int size()

Returns the number of properties in the map.

Returns:

the number of properties.

isEmpty

boolean isEmpty()

Returns true if the map is empty.

Returns:

true if the map is empty.

containsProperty

boolean containsProperty(IPropertyName propertyName)

Returns true if the map contains a property with the specified name.

Parameters:

propertyName - the property name to search for.

Returns:

true if the map contains a property with the specified name.

containsProperty

boolean containsProperty(IProperty property)

Returns true if the map contains the specified property.

Parameters:

property - the property to search for.

Returns:

true if the map contains the specified property.

get

IProperty get(IPropertyName propertyName)

Returns the property with the specified name or null if there is no such property.

Parameters:

propertyName - the property name to search for.

Returns:

the property with the specified name or null if there is no such property.

iterator

IPropertyIterator iterator()

Returns an iterator for the property map.

Returns:

an iterator for the property map.

getMutable

IMutablePropertyMap getMutable()

Returns a copy of the map that can be modified.

Returns:

a copy of the map that can be modified.

getExceptions

Map getExceptions()

Returns a map from IPropertyNames to Exceptions for every property for which an internal error occured during retrieval (not being defined is not an error condition).

Returns:

the map (will be empty if no exception have been recorded)

getException

Exception getException(IPropertyName propertyName)

Given a property that does not appear in the property map, query for a possible exception that occured internally when computing it.

Parameters:

propertyName - name of property

Returns:

the exception or null

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM