Package org.opencms.file.collectors

Interface I_CmsCollectorPublishListProvider

All Known Subinterfaces:

I_CmsResourceCollector

All Known Implementing Classes:

A_CmsResourceCollector, CmsCategoryResourceCollector, CmsChangedResourceCollector, CmsDateResourceCollector, CmsDefaultCollectorPublishListProvider, CmsDefaultResourceCollector, CmsJspTagSearch, CmsJspTagSimpleSearch, CmsPriorityResourceCollector, CmsSolrCollector, CmsSubscriptionCollector, CmsTimeFrameCategoryCollector

public interface I_CmsCollectorPublishListProvider

Interface which should be used for collectors which can provide their own publish list.

Method Summary

Modifier and Type	Method	Description
Set<CmsResource>	getPublishResources(CmsObject cms, I_CmsContentLoadCollectorInfo info)	Gets the publish list for the collector.

Method Details

getPublishResources

Set<CmsResource> getPublishResources(CmsObject cms,
 I_CmsContentLoadCollectorInfo info)
                              throws CmsException

Gets the publish list for the collector.

Parameters:

cms - the CMS context to use

info - the collector information

Returns:

the resources to include in the publish list

Throws:

CmsException - if soemthing goes wrong