OSID Logo
OSID Specifications
course package
Version 3.0.0
Interfaceosid.course.TermSearch
Implementsosid.OsidSearch
Used Byosid.course.TermSearchSession
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_ARGUMENTtermIds is null
CompliancemandatoryThis method must be implemented.
MethodorderTermResults
Description

Specify an ordering to the search results.

Parametersosid.course.TermSearchOrdertermSearchOrderterm search order
ErrorsNULL_ARGUMENTtermSearchOrder is null
UNSUPPORTEDtermSearchOrder 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_ARGUMENTtermSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(termSearchRecordType) is false
CompliancemandatoryThis method must be implemented.