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

The search interface for governing course searches.

MethodsearchAmongCourses
Description

Execute this search among the given list of courses.

Parametersosid.id.IdListcourseIdslist of courses
ErrorsNULL_ARGUMENT courseIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCourseResults
Description

Specify an ordering to the search results.

Parametersosid.course.CourseSearchOrdercourseSearchOrdercourse search order
ErrorsNULL_ARGUMENT courseSearchOrder is null
UNSUPPORTED courseSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCourseSearchRecord
Description

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