public interface SearchOp<T> extends SPIOperation
For more information
Modifier and Type | Method and Description |
---|---|
FilterTranslator<T> |
createFilterTranslator(ObjectClass oclass,
OperationOptions options)
Creates a filter translator that will translate a specified
filter
into one or more native queries. |
void |
executeQuery(ObjectClass oclass,
T query,
ResultsHandler handler,
OperationOptions options)
ConnectorFacade calls this method once for each native query
that the FilterTranslator
produces in response to the
Filter passed into
SearchApiOp . |
FilterTranslator<T> createFilterTranslator(ObjectClass oclass, OperationOptions options)
filter
into one or more native queries.
Each of these native queries will be passed subsequently into
executeQuery()
.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.null
.
A null
return value will cause the API
(SearchApiOp
) to throw NullPointerException
.void executeQuery(ObjectClass oclass, T query, ResultsHandler handler, OperationOptions options)
Filter
passed into
SearchApiOp
.
If the FilterTranslator
produces more than one native query, then ConnectorFacade
will automatically merge the results from each query and eliminate any duplicates.
NOTE that this implies an in-memory data structure that holds a set of
Uid values, so memory usage in the event of multiple queries will be O(N)
where N is the number of results. This is why it is important that
the FilterTranslator for each Connector implement OR if possible.oclass
- The object class for the search. Will never be null.query
- The native query to run. A value of null means
"return every instance of the given object class".handler
- Results should be returned to this handleroptions
- 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 guard against options being null.Copyright © 2013. All Rights Reserved.