Skip navigation links

org.identityconnectors.framework.api.operations
Interface SearchApiOp

All Superinterfaces:

APIOperation

All Known Subinterfaces:

ConnectorFacade

public interface SearchApiOp

extends APIOperation

Retrieve ConnectorObjects that match a speciifed filter (i.e., set of query conditions).

Field Summary

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

NO_TIMEOUT

Method Summary

void	search(ObjectClass oclass, Filter filter, ResultsHandler handler, OperationOptions options) Search the resource for all objects that match the object class and filter.

Method Detail

search

void search(ObjectClass oclass,
            Filter filter,
            ResultsHandler handler,
            OperationOptions options)

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

Parameters:

oclass - 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.

Throws:

java.lang.RuntimeException - iff there is problem during the processing of the results.

Skip navigation links