public interface TermSearchSession extends TermQuerySession
This session provides methods for searching among Term
objects. The search query is constructed using the TermQuery.
getTermsByQuery()
is the basic search method and
returns a list of Terms.
A more advanced search may be
performed with getTermsBySearch().
It accepts a
TermSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getTermsBySearch()
returns a TermsSearchResults
that can be used to access the resulting TermList
or be
used to perform a search within the result set through TermSearch.
This session defines views that offer differing behaviors for searching.
Terms may have a query record indicated by their respective record
types. The query record is accessed via the TermQuery.
Modifier and Type | Method and Description |
---|---|
TermQuery |
getTermQueryFromInspector(TermQueryInspector termQueryInspector)
Gets a term query from an inspector.
|
TermSearchResults |
getTermsBySearch(TermQuery termQuery,
TermSearch termSearch)
Gets the search results matching the given search query using the
given search.
|
TermSearch |
getTermSearch()
Gets a term search.
|
TermSearchOrder |
getTermSearchOrder()
Gets a term search order.
|
canSearchTerms, getCourseCatalog, getCourseCatalogId, getTermQuery, getTermsByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
TermSearch getTermSearch()
mandatory
- This method must be implemented. TermSearchOrder getTermSearchOrder()
TermSearchOrder
is
supplied to a TermSearch
to specify the ordering of
results.mandatory
- This method must be implemented. TermSearchResults getTermsBySearch(TermQuery termQuery, TermSearch termSearch) throws OperationFailedException, PermissionDeniedException
termQuery
- the term querytermSearch
- the term searchNullArgumentException
- termQuery
or
termSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- termQuery
or
termSearch
is not of this servicemandatory
- This method must be implemented. TermQuery getTermQueryFromInspector(TermQueryInspector termQueryInspector)
TermSearchResults.
termQueryInspector
- a term query inspectorNullArgumentException
- termQueryInspector
is null
UnsupportedException
- termQueryInspector
is not of this servicemandatory
- This method must be implemented.