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

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

MethodgetCourseEntries
Description

Gets the course list resulting from a search.

Returnosid.course.chronicle.CourseEntryListthe course entry list
ErrorsILLEGAL_STATEthe course entry list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCourseEntryQueryInspector
Description

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

Returnosid.course.chronicle.CourseEntryQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCourseEntrySearchResultsRecord
Description

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