OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.TermSearch
Implementsosid.OsidSearch
Description

The search interface for governing term searches.

MethodsearchAmongTerms
Description

Execute this search among the given list of terms.

Parametersosid.id.IdListtermIdslist of terms
ErrorsNULL_ARGUMENT termIds is null
CompliancemandatoryThis method must be implemented.
MethodorderTermResults
Description

Specify an ordering to the search results.

Parametersosid.course.TermSearchOrdertermSearchOrderterm search order
ErrorsNULL_ARGUMENT termSearchOrder is null
UNSUPPORTED termSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetTermSearchRecord
Description

Gets the term search record corresponding to the given term search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypetermSearchRecordTypea term search record type
Returnosid.course.records.TermSearchRecordthe term search record
ErrorsNULL_ARGUMENT termSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(termSearchRecordType) is false
CompliancemandatoryThis method must be implemented.