com.sapportals.wcm.repository.filter

Interface IPropertyFilter

All Superinterfaces:

IFilter

All Known Implementing Classes:

AbstractPropertyFilter

public interface IPropertyFilter

extends IFilter

Property filters are used to manipulate resource properties and their visibility. They can modify, delete or add properties to a resource.

For example, with the help of a filter it is possible to change the property that specifies the author of resource. The personal name of the author can be changed to the company name.

Method Summary

IPropertyMap	filter() Returns the filtered property map.
Properties	getFilterContext()
PropertyFilterMode	getFilterMode() Get the FilterMode attribute of the IPropertyFilter object.
IPropertyNameList	getPropertyNameList() Get the property name list if mode is SINGLE_PROPERTY or PROPERTY_LIST.
IRepositoryManager	getRepositoryManager() Returns the repository manager of the new resource in case the write filter is applied to a create operation.
IResource	getResource() Returns the resource that will be filtered.
URI	getURI() Returns the URI of the new resource in case the property write filter is applied to a create operation.

Method Detail

getFilterContext

public Properties getFilterContext()

Returns:

filterContext

getResource

public IResource getResource()
                      throws WcmException

Returns the resource that will be filtered. Will return null if a property write filter is applied to a create operation.

Returns:

The resource

Throws:

WcmException

getURI

public URI getURI()
           throws WcmException

Returns the URI of the new resource in case the property write filter is applied to a create operation.

Returns:

The URI

Throws:

WcmException

getRepositoryManager

public IRepositoryManager getRepositoryManager()
                                        throws WcmException

Returns the repository manager of the new resource in case the write filter is applied to a create operation.

Returns:

A reference to a repository manager instance

Throws:

WcmException

getFilterMode

public PropertyFilterMode getFilterMode()
                                 throws WcmException

Get the FilterMode attribute of the IPropertyFilter object.

Returns:

The FilterMode value

Throws:

WcmException - Exception raised in failure situation

getPropertyNameList

public IPropertyNameList getPropertyNameList()
                                      throws WcmException

Get the property name list if mode is SINGLE_PROPERTY or PROPERTY_LIST.

Returns:

The FilterMode value

Throws:

WcmException - Exception raised in failure situation

filter

public IPropertyMap filter()
                    throws WcmException

Returns the filtered property map. A filter implementation must never return null or a new empty map. If the filter will not change the map or encounters an error it must return the map 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 property map

Throws:

WcmException