com.sapportals.wcm.repository.filter

Interface INamespaceFilterManager

All Superinterfaces:

IFilterManager

All Known Implementing Classes:

AbstractNamespaceFilterManager, AbstractNamespaceFilterManagerEnums

public interface INamespaceFilterManager
extends IFilterManager

A namespace filter manager implements the behaviour for applying namespace filters. It can decide whether to apply a filter and will create the appropriate filter objects and initialize them with the content to filter.

Method Summary

INamespaceFilter	getFilterForRead(INamespaceFilter nmspFilter, NamespaceFilterMode mode) Returns a read filter object that should be applied to the resource list of the predecessor filter.
INamespaceFilter	getFilterForWrite(INamespaceFilter nmspFilter) Returns a write filter objects

Methods inherited from interface com.sapportals.wcm.repository.filter.IFilterManager

getType

Method Detail

getFilterForRead

INamespaceFilter getFilterForRead(INamespaceFilter nmspFilter,
                                  NamespaceFilterMode mode)
                                  throws com.sapportals.wcm.WcmException

Returns a read filter object that should be applied to the resource list of the predecessor filter. If the manager decides not to apply a filter it must return the reference to the predecessor filter. It should not return null here, but instead throw an exception if something went wrong. Returning null or throwing an exception will stop the filtering process.

Parameters:

nmspFilter - The predecessor filter in the cascade

mode - The namespace filter mode that specifies for which operation the filter is called (getResource, getChildren, etc.)

Returns:

The filter object

Throws:

com.sapportals.wcm.WcmException

getFilterForWrite

INamespaceFilter getFilterForWrite(INamespaceFilter nmspFilter)
                                   throws com.sapportals.wcm.WcmException

Returns a write filter objects

Parameters:

nmspFilter - The predecessor filter in the cascade

Returns:

The filter object

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

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