com.sapportals.wcm.service.xcrawler

Interface IXCrawlerPushedDeltaResultReceiver

All Superinterfaces:

IXCrawlerResultReceiver

public interface IXCrawlerPushedDeltaResultReceiver
extends IXCrawlerResultReceiver

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

Version for incremental updates.

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	receiveChanged(RID rid, ArrayList faulty) Receive a changed resource.
boolean	receiveDeleted(RID rid, ArrayList faulty) Receive a deleted resource.
boolean	receiveNew(RID rid, ArrayList faulty) Receive a new resource.
boolean	receiveUnvisited(RID rid, ArrayList faulty) Receive an unvisited unchanged resource.
boolean	receiveUnvisitedChanged(RID rid, ArrayList faulty) Receive an unvisited changed resource.
boolean	receiveUnvisitedDeleted(RID rid, ArrayList faulty) Receive an unvisited deleted resource.

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

approveCollectionCrawling, crawlFailed, crawlFinished, crawlStarted, crawlStopped, getResourceContext

Method Detail

receiveNew

boolean receiveNew(RID rid,
                   ArrayList faulty)
                   throws Exception

Receive a new resource.

Parameters:

rid - of the new 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

receiveChanged

boolean receiveChanged(RID rid,
                       ArrayList faulty)
                       throws Exception

Receive a changed resource.

Parameters:

rid - of the changed 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

receiveDeleted

boolean receiveDeleted(RID rid,
                       ArrayList faulty)
                       throws Exception

Receive a deleted resource.

Parameters:

rid - of the deleted 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

receiveUnvisited

boolean receiveUnvisited(RID rid,
                         ArrayList faulty)
                         throws Exception

Receive an unvisited unchanged resource.

Parameters:

rid - of the unvisited unchanged 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

receiveUnvisitedChanged

boolean receiveUnvisitedChanged(RID rid,
                                ArrayList faulty)
                                throws Exception

Receive an unvisited changed resource.

Parameters:

rid - of the unvisited changed 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

receiveUnvisitedDeleted

boolean receiveUnvisitedDeleted(RID rid,
                                ArrayList faulty)
                                throws Exception

Receive an unvisited deleted resource.

Parameters:

rid - of the unvisited deleted 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