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

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

MethodgetCourseCatalogs
Description

Gets the course catalog list resulting from a search.

Returnosid.course.CourseCatalogListthe course catalog list
ErrorsILLEGAL_STATEthe course catalog list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogQueryInspector
Description

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

Returnosid.course.CourseCatalogQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogSearchResultsRecord
Description

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

Parametersosid.type.TypecourseCatalogSearchRecordTypea course catalog search record type
Returnosid.course.records.CourseCatalogSearchResultsRecordthe course catalog search results record
ErrorsNULL_ARGUMENT courseCatalogSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(courseCatalogSearchRecordType) is false
CompliancemandatoryThis method must be implemented.