OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.TermSearchSession
Implementsosid.course.TermQuerySession
Description

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.

  • federated course catalog view: searches include terms in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
  • isolated course catalog view: searches are restricted to terms in this course catalog

Terms may have a query record indicated by their respective record types. The query record is accessed via the TermQuery.

MethodgetTermSearch
Description

Gets a term search.

Returnosid.course.TermSearchthe term search
CompliancemandatoryThis method must be implemented.
MethodgetTermSearchOrder
Description

Gets a term search order. The TermSearchOrder is supplied to a TermSearch to specify the ordering of results.

Returnosid.course.TermSearchOrderthe term search order
CompliancemandatoryThis method must be implemented.
MethodgetTermsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.course.TermQuerytermQuerythe term query
osid.course.TermSearchtermSearchthe term search
Returnosid.course.TermSearchResultsthe term search results
ErrorsNULL_ARGUMENT termQuery or termSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED termQuery or termSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetTermQueryFromInspector
Description

Gets a term query from an inspector. The inspector is available from a TermSearchResults.

Parametersosid.course.TermQueryInspectortermQueryInspectora term query inspector
Returnosid.course.TermQuerythe term query
ErrorsNULL_ARGUMENT termQueryInspector is null
UNSUPPORTED termQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.