Interface | osid.course.TermSearchSession | ||
---|---|---|---|
Implements | osid.course.TermQuerySession | ||
Description |
This session provides methods for searching among 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
| ||
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 | ||
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 |
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 | ||
Parameters | osid.course.TermQueryInspector | termQueryInspector | a term query inspector |
Return | osid.course.TermQuery | the term query | |
Errors | NULL_ARGUMENT | termQueryInspector is null | |
UNSUPPORTED | termQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |