Package org.identityconnectors.framework.common.objects

Interface ResultsHandler

All Known Subinterfaces:
SearchResultsHandler
public interface ResultsHandler
Callback interface for operations that are returning one or more results. Currently used only by Search, but may be used by other operations in the future.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    handle(ConnectorObject connectorObject)
    Invoked each time a matching ConnectorObject is returned from a query request.

  • Method Details

    • handle

      boolean handle(ConnectorObject connectorObject)
      Invoked each time a matching ConnectorObject is returned from a query request.
      Parameters:
      connectorObject - The matching ConnectorObject.
      Returns:
      true if this handler should continue to be notified of any remaining matching ConnectorObjects, or false if the remaining ConnectorObjects should be skipped for some reason (e.g. a client side size limit has been reached or the failed to handle the last item). If returns false the last items should be considers unhandled and in next page request it should be the first item.
      Throws:
      RuntimeException - the implementor should throw a RuntimeException that wraps any native exception (or that describes any other problem during execution) that is serious enough to stop the iteration.