OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.CourseCatalogSearch
Implementsosid.OsidSearch
Description

The search interface for governing course catalog searches.

MethodsearchAmongCourseCatalogs
Description

Execute this search among the given list of course catalogs.

Parametersosid.id.IdListcourseCatalogIdslist of course catalogs
ErrorsNULL_ARGUMENT courseCatalogIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCourseCatalogResults
Description

Specify an ordering to the search results.

Parametersosid.course.CourseCatalogSearchOrdercourseCatalogSearchOrdercourse catalog search order
ErrorsNULL_ARGUMENT courseCatalogSearchOrder is null
UNSUPPORTED courseCatalogSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogSearchRecord
Description

Gets the course catalog search 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.CourseCatalogSearchRecordthe course catalog search record
ErrorsNULL_ARGUMENT courseCatalogSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(courseCatalogSearchRecordType) is false
CompliancemandatoryThis method must be implemented.