retrieveSearchableObjects
public java.util.Iterator<SearchObject> retrieveSearchableObjects(java.util.Collection<java.lang.Object> categories,
java.util.List<java.lang.Object> searchObjects,
TaskProgressListener progress)
Returns an iterator that provides all of the objects described by the parameters. The iterator will generally
stream the results, calculating the next object on each call to hasNext().
The provided ProgressListener can be used to provide progress information as the Iterator is processed. Some
providers may not be able to calculate progress, in which case they should call setIndeterminate(true), but the
provider implementors are encouraged to provide anything they can, even if it's very coarse.
- Specified by:
retrieveSearchableObjects
in interface SearchProvider
- Overrides:
retrieveSearchableObjects
in class ScriptConfigSearchProvider<ClientScriptConfig>
- Parameters:
categories
- indicates the user selection (if applicable) of which categories should be searched.
searchObjects
- the user selected objects (if applicable) to be searched.
progress
- a progress listener for this provider, which can be updated as the returned Iterator is used. If not
supported, the provider should call setIndeterminate(true).
- Returns: