com.sapportals.wcm.service.xcrawler
Interface IXCrawlerResultReceiver

[contained in: com.sap.km.cm.service.base.par - km.shared.service.xcrawler_api.jar]

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(java.lang.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

public void crawlStarted()
                  throws java.lang.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

crawlFinished

public void crawlFinished()
                   throws java.lang.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

crawlStopped

public void crawlStopped()
                  throws java.lang.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

crawlFailed

public void crawlFailed(java.lang.Exception e)
                 throws java.lang.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

getResourceContext

public IResourceContext getResourceContext()
                                    throws java.lang.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

approveCollectionCrawling

public boolean approveCollectionCrawling(RID rid)
                                  throws java.lang.Exception

Check, whether a collection should be crawled or not.

Parameters:

rid - RID of thr collection

Returns:

true iff the collection should be crawled

Throws:

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