SAP NetWeaver '04

com.sapportals.wcm.repository
Interface IPropertyMap

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.framework_api.jar]
All Known Subinterfaces:
IMutablePropertyMap
All Known Implementing Classes:
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.
 java.lang.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.
 java.util.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

public int size()
Returns the number of properties in the map.
Returns:
the number of properties.

isEmpty

public boolean isEmpty()
Returns true if the map is empty.
Returns:
true if the map is empty.

containsProperty

public 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

public 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

public 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

public IPropertyIterator iterator()
Returns an iterator for the property map.
Returns:
an iterator for the property map.

getMutable

public IMutablePropertyMap getMutable()
Returns a copy of the map that can be modified.
Returns:
a copy of the map that can be modified.

getExceptions

public java.util.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

public java.lang.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

SAP NetWeaver '04

Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.