public interface EngineSearchSession extends EngineQuerySession
This session provides methods for searching Engine
objects. The search query is constructed using the EngineQuery.
The engine record Type
also specifies the recod for
the engine query.
getEnginesByQuery()
is the basic search method and
returns a list of Engine
elements. A more advanced search
may be performed with getEnginesBySearch().
It accepts an
EngineSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getEnginesBySearch()
returns a
EngineSearchResults
that can be used to access the resulting
EngineList
or be used to perform a search within the result
set through EngineSearch.
Engines may have an engine query record indicated by their respective
record types. The engine query record is accessed via the
EngineQuery.
The returns in this session may not be cast directly
to these interfaces.
Modifier and Type | Method and Description |
---|---|
EngineQuery |
getEngineQueryFromInspector(EngineQueryInspector engineQueryInspector)
Gets an engine query from an inspector.
|
EngineSearchResults |
getEnginesBySearch(EngineQuery engineQuery,
EngineSearch engineSearch)
Gets the search results matching the given search.
|
EngineSearch |
getEngineSearch()
Gets an engine search.
|
EngineSearchOrder |
getEngineSearchOrder()
Gets an engine search order.
|
canSearchEngines, getEngineQuery, getEnginesByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
EngineSearch getEngineSearch()
mandatory
- This method must be implemented. EngineSearchOrder getEngineSearchOrder()
EngineSearchOrder
is
supplied to a EngineSearch
to specify the ordering of
results.mandatory
- This method must be implemented. EngineSearchResults getEnginesBySearch(EngineQuery engineQuery, EngineSearch engineSearch) throws OperationFailedException, PermissionDeniedException
engineQuery
- the engine queryengineSearch
- the engine searchNullArgumentException
- engineQuery
or
engineSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- engineQuery
or
engineSearch
is not of this servicemandatory
- This method must be implemented. EngineQuery getEngineQueryFromInspector(EngineQueryInspector engineQueryInspector)
EngineSearchResults.
engineQueryInspector
- an engine query inspectorNullArgumentException
- engineQueryInspector
is null
UnsupportedException
- engineQueryInspector
is not of this servicemandatory
- This method must be implemented.