com.sapportals.wcm.repository.filter

Class AbstractPropertyFilterManager

java.lang.Object
  com.sapportals.wcm.repository.filter.AbstractFilterManager
      com.sapportals.wcm.repository.filter.AbstractPropertyFilterManager

All Implemented Interfaces:

IComponent, IComponentInfo, IConfigurable, ILifecycleInfo, IStartable, IThreadSafe, IFilterManager, IPropertyFilterManager

Direct Known Subclasses:

AttachmentCountFilterManager, AttachmentDisplayNamePropertyFilterManager, GroupWareAttachmentStyleFilterManager

public abstract class AbstractPropertyFilterManager
extends AbstractFilterManager
implements IPropertyFilterManager

Abstract base class for property filter managers.

Copyright (c) SAP AG 2001 - 2002

Nested Class Summary

Nested classes/interfaces inherited from class com.sapportals.wcm.repository.filter.AbstractFilterManager

AbstractFilterManager.CFG, AbstractFilterManager.FILTER_PRIO, AbstractFilterManager.TYPE

Field Summary

Fields inherited from class com.sapportals.wcm.repository.filter.AbstractFilterManager

config, properties, stateHandler

Constructor Summary

	AbstractPropertyFilterManager()
protected	AbstractPropertyFilterManager(Properties properties) Deprecated. As of EP 5.0 SP5, replaced by default (public, no arguments) constructor.

Method Summary

protected void	changeSystemProperties(IConfiguration newConfig) Changes the system properties of a filter manager.
IPropertyNameList	getFilteredPropertyNamesForRead() Returns the names used by this filter for adding properties.
FilterType	getType() Returns the type of the IFilterManager object

Methods inherited from class com.sapportals.wcm.repository.filter.AbstractFilterManager

callUpdateFilter, checkNotReconfigurableAttributes, configure, convertConfigToProperties, convertConfigToProperties, getCreationDate, getDescription, getID, getLastConfigurationException, getLastReconfigurationDate, getName, getNextAutoRestartDate, getProperties, getStartupException, getState, parseValueList, shutDown, shutDownImpl, start, startUp, startUpImpl, stop, throwConfigurationException

Methods inherited from class java.lang.Object

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

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

getFilterForRead, getFilterForWrite

Constructor Detail

AbstractPropertyFilterManager

protected AbstractPropertyFilterManager(Properties properties)

Deprecated. As of EP 5.0 SP5, replaced by default (public, no arguments) constructor.

Parameters:

properties - TBD: Description of the incoming method parameter

AbstractPropertyFilterManager

public AbstractPropertyFilterManager()

Method Detail

getType

public final FilterType getType()

Description copied from interface: IFilterManager

Returns the type of the IFilterManager object

Specified by:

getType in interface IFilterManager

Returns:

The type of this manager

getFilteredPropertyNamesForRead

public IPropertyNameList getFilteredPropertyNamesForRead()

Returns the names used by this filter for adding properties. Can be null e.g. in case the filter does not add properties but only removes properties. Property names returned by this call MUST not be persisted as resource properties in a repository. The purpose of this method is a performance optimization done in the RF. The property names returned by this call are never requested from a repository because it is assumed that they are only created by this filter ! The RF will call this method only once per filter manager. This base class imlementation returns null and could be overwritten in the sub class.

Returns:

the names used by the filter for adding properties.

changeSystemProperties

protected final void changeSystemProperties(IConfiguration newConfig)
                                     throws ConfigurationException

Description copied from class: AbstractFilterManager

Changes the system properties of a filter manager. Must be used by filter managers in the implementation of the reconfigure() method.

Specified by:

changeSystemProperties in class AbstractFilterManager

Parameters:

newConfig - TBD: Description of the incoming method parameter

Throws:

ConfigurationException - Exception raised in failure situation

See Also:

AbstractFilterManager.changeSystemProperties(IConfiguration)

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