com.sapportals.wcm.repository.filter

Interface INamespaceFilter

All Superinterfaces:

IFilter

public interface INamespaceFilter
extends IFilter

A namespace filter will be applied on namespace operations like getResource(), getChildren(). Example: It can remove or add resource to the list of children of a collection.

Method Summary

IResourceList	filter() Returns the filtered resource list.
ICollection	getCollection() Returns the collection if the filter is applied on getChilden().

Method Detail

getCollection

ICollection getCollection()
                          throws com.sapportals.wcm.WcmException

Returns the collection if the filter is applied on getChilden(). Returns null if the filter is applied for getResource() or search().

Returns:

The collection value

Throws:

com.sapportals.wcm.WcmException - Description of the Exception

filter

IResourceList filter()
                     throws com.sapportals.wcm.WcmException

Returns the filtered resource list. A filter implementation must never return null or a new empty list. If the filter will not change the list or encounters an error it must return the list returned by the predecessor filter's filter() method. If the predecessor's filter() method throws an exception this exception should not be catched (or catched and re-thrown).

Returns:

The filtered resource list

Throws:

com.sapportals.wcm.WcmException

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