OSID Logo
OSID Specifications
course package
Version 3.1.0
Interfaceosid.course.TermSearchResults
Implementsosid.OsidSearchResults
Used Byosid.course.TermSearchSession
Description

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

MethodgetTerms
Description

Gets the term list resulting from a search.

Returnosid.course.TermList the term list
ErrorsILLEGAL_STATE the term list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetTermQueryInspector
Description

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

Returnosid.course.TermQueryInspector the query inspector
Compliancemandatory This 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.TypetermSearchRecordType a term search record type
Returnosid.course.records.TermSearchResultsRecord the term search results record
ErrorsNULL_ARGUMENT termSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(termSearchRecordType) is false
Compliancemandatory This method must be implemented.