Package org.identityconnectors.framework.api.operations

Interface SearchApiOp

All Superinterfaces:

APIOperation

All Known Subinterfaces:

ConnectorFacade

public interface SearchApiOp
extends APIOperation

Field Summary

Fields inherited from interface org.identityconnectors.framework.api.operations.APIOperation

DEFAULT_TIMEOUT, NO_TIMEOUT, OPERATION_TIMEOUTS

Method Summary

Modifier and Type	Method	Description
SearchResult	search(ObjectClass objectClass, Filter filter, ResultsHandler handler, OperationOptions options)	Search the resource for all objects that match the object class and filter.

Method Details

search

SearchResult search(ObjectClass objectClass,
 Filter filter,
 ResultsHandler handler,
 OperationOptions options)

Search the resource for all objects that match the object class and filter.

Parameters:

objectClass - reduces the number of entries to only those that match the ObjectClass provided.

filter - Reduces the number of entries to only those that match the Filter provided, if any. May be null.

handler - class responsible for working with the objects returned from the search.

options - additional options that impact the way this operation is run. May be null.

Returns:

The query result or null.

Throws:

RuntimeException - if there is problem during the processing of the results.