OSID Logo
OSID Specifications
course syllabus package
Version 3.1.0
Interfaceosid.course.syllabus.ModuleSearchResults
Implementsosid.OsidSearchResults
Used Byosid.course.syllabus.ModuleSearchSession
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.ModuleList the module list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetModuleQueryInspector
Description

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

Returnosid.course.syllabus.ModuleQueryInspector the module query inspector
Compliancemandatory This 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.TypemoduleSearchRecordType a module search record type
Returnosid.course.syllabus.records.ModuleSearchResultsRecord the module search record
ErrorsNULL_ARGUMENT moduleSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(moduleSearchRecordType) is false
Compliancemandatory This method must be implemented.