OSID Logo
OSID Specifications
course syllabus package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.syllabus.SyllabusSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetSyllabi
Description

Gets the syllabus list resulting from a search.

Returnosid.course.syllabus.SyllabusListthe syllabus list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetSyllabusQueryInspector
Description

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

Returnosid.course.syllabus.SyllabusQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetSyllabusSearchResultsRecord
Description

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

Parametersosid.type.TypesyllabusSearchRecordTypea syllabus search record type
Returnosid.course.syllabus.records.SyllabusSearchResultsRecordthe syllabus search record
ErrorsNULL_ARGUMENT syllabusSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(syllabusSearchRecordType) is false
CompliancemandatoryThis method must be implemented.