OSID - osid.course.TermSearchSession Service Interface Definition

Interface	osid.course.TermSearchSession
Implements	`osid.course.TermQuerySession`
Used By	`osid.course.CourseManager`
Used By	`osid.course.CourseProxyManager`
Description	This session provides methods for searching among `Terms` . 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` .
Method	getTermSearch
Description	Gets a term search.
Return	`osid.course.TermSearch`		the term search
Compliance	`mandatory`		This method must be implemented.
Method	getTermSearchOrder
Description	Gets a term search order. The `TermSearchOrder` is supplied to a `TermSearch` to specify the ordering of results.
Return	`osid.course.TermSearchOrder`		the term search order
Compliance	`mandatory`		This method must be implemented.
Method	getTermsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.TermQuery`	`termQuery`	the term query
Parameters	`osid.course.TermSearch`	`termSearch`	the term search
Return	`osid.course.TermSearchResults`		the term search results
Errors	NULL_ARGUMENT		`termQuery` or `termSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`termQuery` or `termSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getTermQueryFromInspector
Description	Gets a term query from an inspector. The inspector is available from a `TermSearchResults` .
Parameters	`osid.course.TermQueryInspector`	`termQueryInspector`	a term query inspector
Return	`osid.course.TermQuery`		the term query
Errors	NULL_ARGUMENT		`termQueryInspector` is `null`
Errors	UNSUPPORTED		`termQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.