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

The search interface for governing course entry searches.

MethodsearchAmongCourseEntries
Description

Execute this search among the given list of course entries.

Parametersosid.id.IdListcourseEntryIdslist of course entry Ids
ErrorsNULL_ARGUMENT courseEntryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCourseEntryResults
Description

Specify an ordering to the search results.

Parametersosid.course.chronicle.CourseEntrySearchOrdercourseEntrySearchOrdercourse entry search order
ErrorsNULL_ARGUMENT courseEntrySearchOrder is null
UNSUPPORTED courseEntrySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCourseEntrySearchRecord
Description

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

Parametersosid.type.TypecourseEntrySearchRecordTypea course entry search record type
Returnosid.course.chronicle.records.CourseEntrySearchRecordthe course entry search record
ErrorsNULL_ARGUMENT courseEntrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(courseEntrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.