OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.TermSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetTerms
Description

Gets the term list resulting from a search.

Returnosid.course.TermListthe term list
ErrorsILLEGAL_STATEthe term list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetTermQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.course.TermQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetTermSearchResultsRecord
Description

Gets the term search results 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.TermSearchResultsRecordthe term search results record
ErrorsNULL_ARGUMENT termSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(termSearchRecordType) is false
CompliancemandatoryThis method must be implemented.