com.sapportals.wcm.repository.batch

Interface IResourceBatch

public interface IResourceBatch

This interface provides methods for operations working on a list of resources.

Method Summary

Map	getLocksInfo() Returns a map containing lock information for the resources in this resource batch.
Map	getProperties(IPropertyNameList propNameList, ResourceErrors errors) Returns a map containing the requested properties which are available for the resources in this resource batch.

Method Detail

getProperties

Map getProperties(IPropertyNameList propNameList,
                  ResourceErrors errors)
                  throws ResourceException

Returns a map containing the requested properties which are available for the resources in this resource batch. The resulting map contains resource identifiers (RID) as keys and IPropertyMap instances as values. If a resource does not exist no entry will exist in the map for the RID (a resource might no longer exist because it was deleted by another user/thread since ICollection.getChildren() or IResourceFactory.getResources() was called). If an exception occurred for some resources they are attached to the (optional) ResourceErrors object. If the ResourceErrors collection contains an exception for a particular RID then this RID will not be contained in the map. If none of the properties where found the RID will not be contained in the result. If the resource list or the property name list is empty an empty map is returned.

Parameters:

propNameList - A list of property names. Must not be null.

errors - Will be used to collect all exceptions which occurred when trying to access the properties of a resource. Can be null.

Returns:

The requested properties which are available for the resources in this batch.

Throws:

ResourceException

Since:

NetWeaver 7.1

getLocksInfo

Map getLocksInfo()
                 throws ResourceException

Returns a map containing lock information for the resources in this resource batch. The resulting map contains resource identifiers (RID) as keys and Object[3] arrays as values. - array[0]: List of ILockInfoCollection If there are no locks it's an empty list. - array[1]: Boolean instance indicating if the resource is locked - array[2]: Boolean instance indicating if the resource is locked by the user in the resource context Returns also deep locks of parent resources if set above the given resource. Returns an empty list if no locks are found for the resources.

Parameters:

resourceHandle - list with resource handles

Returns:

Map with the following elements (resource handle, object array with locks info)

Throws:

ResourceException - when the list of the locks can't be obtained

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