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

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

MethodgetModules
Description

Gets the module list resulting from a search.

Returnosid.course.syllabus.ModuleListthe module list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetModuleQueryInspector
Description

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

Returnosid.course.syllabus.ModuleQueryInspectorthe module query inspector
CompliancemandatoryThis method must be implemented.
MethodgetModuleSearchResultsRecord
Description

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

Parametersosid.type.TypemoduleSearchRecordTypea module search record type
Returnosid.course.syllabus.records.ModuleSearchResultsRecordthe module search record
ErrorsNULL_ARGUMENT moduleSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(moduleSearchRecordType) is false
CompliancemandatoryThis method must be implemented.