com.sapportals.wcm.service.xcrawler

Interface IXCrawlerPushedResultReceiver

All Superinterfaces:

IXCrawlerResultReceiver

public interface IXCrawlerPushedResultReceiver
extends IXCrawlerResultReceiver

Result receiver which receives the result of a crawl as single RIDs as the crawl goes on.

Version for normal crawls.

Copyright (c) SAP AG 2003

Method Summary

void	finalGetFaulty(ArrayList faulty) Final call to get the RIDs which could not be processed by the receiver.
void	indicateStop() Indicate a crawler stop.
boolean	receive(RID rid, ArrayList faulty) Receive a resource.

Methods inherited from interface com.sapportals.wcm.service.xcrawler.IXCrawlerResultReceiver

approveCollectionCrawling, crawlFailed, crawlFinished, crawlStarted, crawlStopped, getResourceContext

Method Detail

receive

boolean receive(RID rid,
                ArrayList faulty)
                throws Exception

Receive a resource.

Parameters:

rid - of the resource

faulty - list of previously provided RIDs which could not be processed by the receiver and shall be treated as erroneous by the crawler (might include the RID passed in this call)

Returns:

true to continue the crawl, false to stop it

Throws:

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

Exception

indicateStop

void indicateStop()
                  throws Exception

Indicate a crawler stop.
When this method is called any pending calls to receive() must return immediately because the crawler is stopping.
The method may be called multiple times before the crawler finally stops.

Throws:

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

Exception

finalGetFaulty

void finalGetFaulty(ArrayList faulty)
                    throws Exception

Final call to get the RIDs which could not be processed by the receiver.

Parameters:

faulty - list of previously provided RIDs which could not be processed by the receiver and shall be treated as erroneous by the crawler (might include the RID passed in this call)

Throws:

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

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