com.sapportals.wcm.service.resourcelistfilter

Interface ICollectionListFilter

public interface ICollectionListFilter

retrieves all children of a parent collection that match the parameters provided

Method Summary

void	addPropertyNames(IPropertyNameList list) allows to add a list of propertynames to be used in the getChildren method of this interface.
IResourceList	getChildren(ICollection parent, IParameters parameters, IPropertyNameList list) retrieves the children of the given parent folder.

Method Detail

getChildren

public IResourceList getChildren(ICollection parent,
                                 IParameters parameters,
                                 IPropertyNameList list)
                          throws WcmException

retrieves the children of the given parent folder. Depending on the given parameters and the implementing class, only a subset of the IResource instances in that folder will be returned. The filtering might take place within the repository framework as well as in the implementing class. Resources might already be ordered.

Parameters:

parent - the collection to retrieve children for, must not be null

parameters - the parameters that specify how the result should be filtered and sorted, must not be null

list - the properties that should be retrieved for the returned resources. This can increase performance, because calls to the RF to retrieve properties are bundled, might be null

Returns:

the children of the given parent that passed the defined filters. Might be an empty list but never null.

Throws:

WcmException

addPropertyNames

public void addPropertyNames(IPropertyNameList list)

allows to add a list of propertynames to be used in the getChildren method of this interface. The implementation of that method must merge these property names with the property names provided in that method.

Parameters:

list - the names of the properties to be used when retrieving resources from the RF. Might be null or an empty list