com.sapportals.wcm.repository.batch

Class ResourcePropertyMap

java.lang.Object
  com.sapportals.wcm.repository.batch.ResourcePropertyMap

public final class ResourcePropertyMap
extends Object

Helper class that can be used to handle the return value of IResourceBatch.getProperties(IPropertyNameList, ResourceErrors).

Constructor Summary

ResourcePropertyMap(Map map)
Constructs a new instance.

Method Summary

IPropertyNameList	calculateContainedNames(com.sapportals.wcm.util.uri.RID rid, IPropertyNameList checkNames) Returns a list of names of properties that are contained in the map for the specified RID.
IPropertyNameList	calculateNotContainedNames(com.sapportals.wcm.util.uri.RID rid, IPropertyNameList checkNames) Returns a list of names of properties that are not contained in the map for the specified RID.
ResourceErrors	getExceptions(com.sapportals.wcm.util.uri.RID rid) Returns a collection of exceptions that occurred for a specified RID.
IPropertyMap	getProperties(com.sapportals.wcm.util.uri.RID rid) Returns the property map for the specified RID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourcePropertyMap

public ResourcePropertyMap(Map map)

Constructs a new instance.

Parameters:

map - A map returned by IResourceBatch.getProperties(IPropertyNameList, ResourceErrors).

Method Detail

getProperties

public IPropertyMap getProperties(com.sapportals.wcm.util.uri.RID rid)

Returns the property map for the specified RID. If none of the requested properties exist a empty map is returned.

Parameters:

rid - The RID to get the properties for.

Returns:

the property map for the specified RID.

calculateNotContainedNames

public IPropertyNameList calculateNotContainedNames(com.sapportals.wcm.util.uri.RID rid,
                                                    IPropertyNameList checkNames)

Returns a list of names of properties that are not contained in the map for the specified RID. The returned list will be a subset of the names to check for.

Parameters:

rid - The RID to check the properties for.

checkNames - The list of property names to check against the available properties.

Returns:

a list of names of properties that are not contained in the map for the specified RID.

calculateContainedNames

public IPropertyNameList calculateContainedNames(com.sapportals.wcm.util.uri.RID rid,
                                                 IPropertyNameList checkNames)

Returns a list of names of properties that are contained in the map for the specified RID. The returned list will be a subset of the names to check for.

Parameters:

rid - The RID to check the properties for.

checkNames - The list of property names to check against the available properties.

Returns:

a list of names of properties that are contained in the map for the specified RID.

getExceptions

public ResourceErrors getExceptions(com.sapportals.wcm.util.uri.RID rid)

Returns a collection of exceptions that occurred for a specified RID.

Parameters:

rid - The rid to get the excpetion for.

Returns:

Returns a collection of exceptions that occurred for a specified RID.

Access Rights

This class can be accessed from:

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