com.sapportals.wcm.service.xcrawler

Interface IXCrawlerResultReceiver

All Known Subinterfaces:

IXCrawlerListDeltaResultReceiver, IXCrawlerListResultReceiver, IXCrawlerPushedDeltaResultReceiver, IXCrawlerPushedResultReceiver

public interface IXCrawlerResultReceiver

Abstract result receiver - all result receivers must implement this interface.

Version for normal crawls.

Copyright (c) SAP AG 2003

Method Summary

boolean	approveCollectionCrawling(RID rid) Check, whether a collection should be crawled or not.
void	crawlFailed(Exception e) Called to inform the result receiver that the crawl failed.
void	crawlFinished() Called to inform the result receiver that the crawl has been finished.
void	crawlStarted() Called to inform the result receiver that the crawl has been started.
void	crawlStopped() Called to inform the result receiver that the ongoing crawl was stopped before finishing.
IResourceContext	getResourceContext() Get the resource context which is used to access crawled resources.

Method Detail

crawlStarted

void crawlStarted()
                  throws Exception

Called to inform the result receiver that the crawl has been started.

Throws:

thrown - in case of error; the exception will not affect the ongoing crawl

Exception

crawlFinished

void crawlFinished()
                   throws Exception

Called to inform the result receiver that the crawl has been finished.

Throws:

thrown - in case of error; the exception will not affect the ongoing crawl

Exception

crawlStopped

void crawlStopped()
                  throws Exception

Called to inform the result receiver that the ongoing crawl was stopped before finishing.

Throws:

thrown - in case of error; the exception will not affect the ongoing crawl

Exception

crawlFailed

void crawlFailed(Exception e)
                 throws Exception

Called to inform the result receiver that the crawl failed.

Parameters:

e - the exception which led to the failure

Throws:

thrown - in case of error; the exception will not affect the ongoing crawl

Exception

getResourceContext

IResourceContext getResourceContext()
                                    throws Exception

Get the resource context which is used to access crawled resources.

Returns:

the resource context which is used to access crawled resources

Throws:

thrown - in case of error; the exception will abort the ongoing crawl

Exception

approveCollectionCrawling

boolean approveCollectionCrawling(RID rid)
                                  throws Exception

Check, whether a collection should be crawled or not.

Parameters:

rid - RID of the collection

Returns:

true if the collection should be crawled

Throws:

thrown - in case of error; the exception cause the collection to be skipped

Exception

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM