OSID Logo
OSID Specifications
course syllabus package
Version 3.0.0
Interfaceosid.course.syllabus.ModuleSearch
Implementsosid.OsidSearch
Used Byosid.course.syllabus.ModuleSearchSession
Description

The search interface for governing module searches.

MethodsearchAmongModules
Description

Execute this search among the given list of modules.

Parametersosid.id.IdListmoduleIdslist of modules
ErrorsNULL_ARGUMENTmoduleIds is null
CompliancemandatoryThis method must be implemented.
MethodorderModuleResults
Description

Specify an ordering to the search results.

Parametersosid.course.syllabus.ModuleSearchOrdermoduleSearchOrdermodule search order
ErrorsNULL_ARGUMENTmoduleSearchOrder is null
UNSUPPORTEDmoduleSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetModuleSearchRecord
Description

Gets the module search 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.ModuleSearchRecordthe module search record
ErrorsNULL_ARGUMENTmoduleSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(moduleSearchRecordType) is false
CompliancemandatoryThis method must be implemented.