com.sapportals.wcm.service.reporting.walker

Interface IResourceObserver

public interface IResourceObserver

Interface for resource observer functionality inside a IReport.

Copyright (c) SAP AG 2003-2005

Method Summary

void	endCollection(ICollection col) Invoked when traversal of a collection was finished.
boolean	isStillListening() Signals that any further invocations of startCollection(ICollection), endCollection(ICollection) and observe(IResource) will have no effect.
void	observe(IResource resource) Invoked when a resource is to be inspected.
void	observeError(RID rid, String message, Throwable t)
boolean	startCollection(ICollection col) Invoked before a collection is entered.

Method Detail

isStillListening

public boolean isStillListening()

Signals that any further invocations of startCollection(ICollection), endCollection(ICollection) and observe(IResource) will have no effect.

Returns:

true if the observer is still interested in more resources to be observed.

startCollection

public boolean startCollection(ICollection col)
                        throws ResourceException,
                               InterruptedException

Invoked before a collection is entered.

Parameters:

col - collection being entered

Returns:

true if and only if collection should be traversed.

Throws:

ResourceException - when execution should be aborted

InterruptedException

endCollection

public void endCollection(ICollection col)
                   throws ResourceException,
                          InterruptedException

Invoked when traversal of a collection was finished.

Parameters:

col - collection being entered

Throws:

ResourceException - when execution should be aborted

InterruptedException

observe

public void observe(IResource resource)
             throws ResourceException,
                    InterruptedException

Invoked when a resource is to be inspected.

Parameters:

resource - the IResource being inspected. Note: do not rely on IResource.isCollection() returning true for internal links to collections.

Throws:

ResourceException - when execution should be aborted (in general, most exceptions should be caught and recorded)

InterruptedException - if execution was explicitly aborted

observeError

public void observeError(RID rid,
                         String message,
                         Throwable t)
                  throws ResourceException,
                         InterruptedException

Parameters:

rid - The rid to the reource where the error occured

message - An error message

t - The exception that was caught

Throws:

ResourceException

InterruptedException