com.sapportals.wcm.service.resourcelistfilter

Interface IResourceListFilterService

All Superinterfaces:

IService

public interface IResourceListFilterService

extends IService

Offers methods to retrieve a certain instance of an IResourceListFilter depending on the configuration information given. This service is independent of the standard filters such as INameSpaceFilter configured for a repository. The service does not filter resource lists by itself, it only uses the available information stemming from the IResourceList or the ICollection, the iView and the calling class, to retrieve a fitting IResourceListFilter.

Field Summary

static String

RESOURCELISTFILTERCATEGORY Used as category key for entries added to the IDebugContainer

Method Summary

IResourceListFilter	getResourceListFilter(ICollection collection, Hashtable table, IFlavor flavor, IDebugContainer debugcontainer) Returns a new instance of the matching IResourceListFilter.
IResourceListFilter	getResourceListFilter(ITypedResourceList list, Hashtable table, IFlavor flavor, IDebugContainer debugcontainer) Returns a new instance of the matching IResourceListFilter.
IResourceListFilter	getStandardResourceListFilter() Returns a new instance of the standard IResourceListFilter defined in the implementing IListFilterService class.

Methods inherited from interface com.sapportals.wcm.service.IService

getDescription, getDescription, getID

Field Detail

RESOURCELISTFILTERCATEGORY

public static final String RESOURCELISTFILTERCATEGORY

Used as category key for entries added to the IDebugContainer

See Also:

Constant Field Values

Method Detail

getStandardResourceListFilter

public IResourceListFilter getStandardResourceListFilter()

Returns a new instance of the standard IResourceListFilter defined in the implementing IListFilterService class.

getResourceListFilter

public IResourceListFilter getResourceListFilter(ITypedResourceList list,
                                                 Hashtable table,
                                                 IFlavor flavor,
                                                 IDebugContainer debugcontainer)
                                          throws WcmException

Returns a new instance of the matching IResourceListFilter. If none is defined, the standard filter (the same as in getStandardResourceListFilter) is returned.

Throws:

WcmException

getResourceListFilter

public IResourceListFilter getResourceListFilter(ICollection collection,
                                                 Hashtable table,
                                                 IFlavor flavor,
                                                 IDebugContainer debugcontainer)
                                          throws WcmException

Returns a new instance of the matching IResourceListFilter. If none is defined, the standard filter (the same as in getStandardResourceListFilter) is returned.

Throws:

WcmException