com.sapportals.wcm.repository

Interface IMutablePropertyMap

All Superinterfaces:
IPropertyMap
All Known Implementing Classes:
MutablePropertyMap

public interface IMutablePropertyMap
extends IPropertyMap

An extention of the IPropertyMap interface with methods to modify the map.


Method Summary
 void addException(IPropertyName propertyName, Exception ex)
          Record an exception for a particular property.
 IPropertyMap getImmutable()
          Returns a read-only version of this map.
 IProperty put(IProperty property)
          Puts a property into the map.
 IProperty remove(IPropertyName propertyName)
          Removes the mapping for the specified property name from this map if present.
 
Methods inherited from interface com.sapportals.wcm.repository.IPropertyMap
containsProperty, containsProperty, get, getException, getExceptions, getMutable, isEmpty, iterator, size
 

Method Detail

put

IProperty put(IProperty property)
Puts a property into the map. Associates the property with the it's IPropertyName as a key in this map. If the map previously contained a mapping for this name, the old property is replaced.

Parameters:
property - The property to add.
Returns:
previous value associated with specified property's name, or null if there was no mapping.

remove

IProperty remove(IPropertyName propertyName)
Removes the mapping for the specified property name from this map if present.

Parameters:
propertyName - TBD: Description of the incoming method parameter
Returns:
previous value associated with specified name, or null if there was no mapping.

getImmutable

IPropertyMap getImmutable()
Returns a read-only version of this map. The map is not copied.

Returns:
a read-only version of this map

addException

void addException(IPropertyName propertyName,
                  Exception ex)
Record an exception for a particular property.

Parameters:
propertyName - name of property
ex - exception
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


Copyright 2014 SAP AG Complete Copyright Notice