OSID Logo
OSID Specifications
course chronicle package
Version 3.1.0
Interfaceosid.course.chronicle.CourseEntrySearchResults
Implementsosid.OsidSearchResults
Used Byosid.course.chronicle.CourseEntrySearchSession
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.CourseEntryList the course entry list
ErrorsILLEGAL_STATE the course entry list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetCourseEntryQueryInspector
Description

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

Returnosid.course.chronicle.CourseEntryQueryInspector the query inspector
Compliancemandatory This 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.TypecourseEntrySearchRecordType a course entry search record type
Returnosid.course.chronicle.records.CourseEntrySearchResultsRecord the course entry search results record
ErrorsNULL_ARGUMENT courseEntrySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(courseEntrySearchRecordType) is false
Compliancemandatory This method must be implemented.