Interface | osid.course.TermSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing term searches. | ||
Method | searchAmongTerms | ||
Description |
Execute this search among the given list of terms. | ||
Parameters | osid.id.IdList | termIds | list of terms |
Errors | NULL_ARGUMENT | termIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderTermResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.course.TermSearchOrder | termSearchOrder | term search order |
Errors | NULL_ARGUMENT | termSearchOrder is null | |
UNSUPPORTED | termSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTermSearchRecord | ||
Description |
Gets the term search record corresponding to the given
term search record | ||
Parameters | osid.type.Type | termSearchRecordType | a term search record type |
Return | osid.course.records.TermSearchRecord | the term search record | |
Errors | NULL_ARGUMENT | termSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(termSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |