public interface RelevancySearchSession extends RelevancyQuerySession
This session provides methods for searching Relevancy
objects. The search query is constructed using the RelevancyQuery.
The relevancy record Type
also specifies the record
for the relevancy query.
getRelevanciesByQuery()
is the basic search method and
returns a list of relevancies. A more advanced search may be performed
with getRelevanciesBySearch().
It accepts a
RelevancySearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getRelevanciesBySearch()
returns a
RelevancySearchResults
that can be used to access the resulting
RelevancyList
or be used to perform a search within the
result set through RelevancySearch.
This session defines views that offer differing behaviors for searching.
Relevancies may have a query record indicated by their respective
record types. The query record is accessed via the RelevancyQuery.
Modifier and Type | Method and Description |
---|---|
RelevancySearchResults |
getRelevanciesBySearch(RelevancyQuery relevancyQuery,
RelevancySearch relevancySearch)
Gets the search results matching the given search query using the
given search.
|
RelevancyQuery |
getRelevancyQueryFromInspector(RelevancyQueryInspector relevancyQueryInspector)
Gets a relevancy query from an inspector.
|
RelevancySearch |
getRelevancySearch()
Gets a relevancy search.
|
RelevancySearchOrder |
getRelevancySearchOrder()
Gets a relevancy search order.
|
canSearchRelevancies, getOntology, getOntologyId, getRelevanciesByQuery, getRelevancyQuery, useFederatedOntologyView, useIsolatedOntologyView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
RelevancySearch getRelevancySearch()
mandatory
- This method must be implemented. RelevancySearchOrder getRelevancySearchOrder()
RelevancySearchOrder
is supplied to a RelevancySearch
to specify the
ordering of results.mandatory
- This method must be implemented. RelevancySearchResults getRelevanciesBySearch(RelevancyQuery relevancyQuery, RelevancySearch relevancySearch) throws OperationFailedException, PermissionDeniedException
relevancyQuery
- the relevancy queryrelevancySearch
- the relevancy searchNullArgumentException
- relevancyQuery
or relevancySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- relevancySearch
or relevancyQuery
is not of this servicemandatory
- This method must be implemented. RelevancyQuery getRelevancyQueryFromInspector(RelevancyQueryInspector relevancyQueryInspector)
RelevancySearchResults.
relevancyQueryInspector
- a relevancy query inspectorNullArgumentException
- relevancyQueryInspector
is null
UnsupportedException
- relevancyQueryInspector
is not of this servicemandatory
- This method must be implemented.