com.sapportals.wcm.repository.filter

Class AbstractPropertyFilter

java.lang.Object
  com.sapportals.wcm.WcmObject
      com.sapportals.wcm.repository.filter.AbstractPropertyFilter

All Implemented Interfaces:

IFilter, IPropertyFilter

public abstract class AbstractPropertyFilter

extends WcmObject

implements IPropertyFilter

Field Summary

protected IPropertyFilter

filter

Fields inherited from class com.sapportals.wcm.WcmObject

ORDER_TYPE_MANUAL, ORDER_TYPE_NONE

Constructor Summary

	AbstractPropertyFilter()
protected	AbstractPropertyFilter(IPropertyFilter filter) Construct object of class AbstractPropertyFilter.

Method Summary

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.

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.IPropertyFilter

filter

Field Detail

filter

protected IPropertyFilter filter

Constructor Detail

AbstractPropertyFilter

public AbstractPropertyFilter()

AbstractPropertyFilter

protected AbstractPropertyFilter(IPropertyFilter filter)

Construct object of class AbstractPropertyFilter.

Parameters:

filter - TBD: Description of the incoming method parameter

Method Detail

getFilterContext

public Properties getFilterContext()

Specified by:

getFilterContext in interface IPropertyFilter

Returns:

filterContext

getResource

public IResource getResource()
                      throws WcmException

Description copied from interface: IPropertyFilter

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

Specified by:

getResource in interface IPropertyFilter

Returns:

The resource

Throws:

WcmException

getURI

public URI getURI()
           throws WcmException

Description copied from interface: IPropertyFilter

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

Specified by:

getURI in interface IPropertyFilter

Returns:

The URI

Throws:

WcmException

getRepositoryManager

public IRepositoryManager getRepositoryManager()
                                        throws WcmException

Description copied from interface: IPropertyFilter

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

Specified by:

getRepositoryManager in interface IPropertyFilter

Returns:

A reference to a repository manager instance

Throws:

WcmException

getFilterMode

public PropertyFilterMode getFilterMode()
                                 throws WcmException

Description copied from interface: IPropertyFilter

Get the FilterMode attribute of the IPropertyFilter object.

Specified by:

getFilterMode in interface IPropertyFilter

Returns:

The FilterMode value

Throws:

WcmException - Exception raised in failure situation

getPropertyNameList

public IPropertyNameList getPropertyNameList()
                                      throws WcmException

Description copied from interface: IPropertyFilter

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

Specified by:

getPropertyNameList in interface IPropertyFilter

Returns:

The FilterMode value

Throws:

WcmException - Exception raised in failure situation