org.identityconnectors.framework.spi

Interface SearchResultsHandler

All Superinterfaces:

ResultsHandler

public interface SearchResultsHandler
extends ResultsHandler

A SearchResultsHandler is a completion handler for consuming the results of a search request.

A search result completion handler may be specified when performing search requests using a ConnectorFacade object. The ResultsHandler.handle(org.identityconnectors.framework.common.objects.ConnectorObject) method is invoked each time a matching ConnectorObject resource is returned, followed by handleResult(org.identityconnectors.framework.common.objects.SearchResult) indicating that no more ConnectorObject resources will be returned.

Implementations of these methods should complete in a timely manner so as to avoid keeping the invoking thread from dispatching to other completion handlers.

Since:

1.4

Author:

Laszlo Hordos

Method Summary

Methods

Modifier and Type	Method and Description
void	handleResult(SearchResult result) Invoked when the request has completed successfully.

Methods inherited from interface org.identityconnectors.framework.common.objects.ResultsHandler

handle

Method Detail

handleResult

void handleResult(SearchResult result)

Invoked when the request has completed successfully.

Parameters:

result - The query result indicating that no more resources are to be returned and, if applicable, including information which should be used for subsequent paged results query requests.