Org.IdentityConnectors.Framework.Spi.Operations.SearchOp< T > Interface Template Reference

Implement this interface to allow the Connector to search for resource objects. More...

Inherits Org.IdentityConnectors.Framework.Spi.Operations.SPIOperation.

Public Member Functions
FilterTranslator< T >	CreateFilterTranslator (ObjectClass oclass, OperationOptions options)
	Creates a filter translator that will translate a specified filter to the native filter. More...
void	ExecuteQuery (ObjectClass oclass, T query, ResultsHandler handler, OperationOptions options)
	This will be called by ConnectorFacade, once for each native query produced by the FilterTranslator. More...

Detailed Description

Implement this interface to allow the Connector to search for resource objects.

Type Constraints

T

:

class

Member Function Documentation

FilterTranslator<T> Org.IdentityConnectors.Framework.Spi.Operations.SearchOp< T >.CreateFilterTranslator	(	ObjectClass	oclass,
		OperationOptions	options
	)

Creates a filter translator that will translate a specified filter to the native filter.

The translated filters will be subsequently passed to Org.IdentityConnectors.Framework.Api.Operations.SearchApiOp.Search(ObjectClass, Filter, ResultsHandler, OperationOptions)

Parameters

oclass	The object class for the search. Will never be null.
options	additional options that impact the way this operation is run. If the caller passes null, the framework will convert this into an empty set of options, so SPI need not worry about this ever being null.

Returns

A filter translator.

void Org.IdentityConnectors.Framework.Spi.Operations.SearchOp< T >.ExecuteQuery	(	ObjectClass	oclass,
		T	query,
		ResultsHandler	handler,
		OperationOptions	options
	)

This will be called by ConnectorFacade, once for each native query produced by the FilterTranslator.

If there is more than one query the results will automatically be merged together and duplicates eliminated. NOTE that this implies an in-memory data structure that holds a set of Uids, so memory usage in the event of multiple queries will be O(N) where N is the number of results. That is why it is important that the FilterTranslator implement OR if possible.

Parameters

oclass	The object class for the search. Will never be null.
query	The native query to run. A value of null means 'return everything for the given object class'.
handler	Results should be returned to this handler
options	additional options that impact the way this operation is run. If the caller passes null, the framework will convert this into an empty set of options, so SPI need not worry about this ever being null.

---

The documentation for this interface was generated from the following file:

• C:/ADE/icfbuild_docgen/icf/framework/.ade_path/dotnet/Framework/SpiOperations.cs