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

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

MethodgetCourses
Description

Gets the course list resulting from a search.

Returnosid.course.CourseListthe course list
ErrorsILLEGAL_STATEthe course list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCourseQueryInspector
Description

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

Returnosid.course.CourseQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCourseSearchResultsRecord
Description

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

Parametersosid.type.TypecourseSearchRecordTypea course search record type
Returnosid.course.records.CourseSearchResultsRecordthe course search results record
ErrorsNULL_ARGUMENT courseSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(courseSearchRecordType) is false
CompliancemandatoryThis method must be implemented.