com.sapportals.wcm.repository.filter

Interface IContentFilterManager2

All Superinterfaces:

IFilterManager

All Known Implementing Classes:

AbstractContentFilterManager2

public interface IContentFilterManager2
extends IFilterManager

This interface defines a content filter manager. It is responsible for the creation of content filter instances and the decision whether a filter should be applied or not.

Method Summary

IContentFilter2	getFilterForRead(IContentFilter2 contentFilter) Returns a read filter object that should be applied to the content of the predecessor filter.
IContentFilter2	getFilterForWrite(IContentFilter2 contentFilter) Returns a write filter instance.

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

getType

Method Detail

getFilterForRead

IContentFilter2 getFilterForRead(IContentFilter2 contentFilter)
                                 throws com.sapportals.wcm.WcmException

Returns a read filter object that should be applied to the content of the predecessor filter. If the manager decides not to apply a filter he must return the reference to the predecessor filter. Implementors 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.

Note: The implementation of this method must not call the IContentFilter2.filter() method.

Parameters:

contentFilter - The predecessor filter in the chain

Returns:

a read filter object

Throws:

com.sapportals.wcm.WcmException

getFilterForWrite

IContentFilter2 getFilterForWrite(IContentFilter2 contentFilter)
                                  throws com.sapportals.wcm.WcmException

Returns a write filter instance.

Parameters:

contentFilter - The predecessor filter in the chain.

Returns:

a write filter instance.

Throws:

com.sapportals.wcm.WcmException

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