OSID Logo
OSID Specifications
course syllabus package
Version 3.1.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.IdListmoduleIds list of modules
ErrorsNULL_ARGUMENT moduleIds is null
Compliancemandatory This method must be implemented.
MethodorderModuleResults
Description

Specify an ordering to the search results.

Parametersosid.course.syllabus.ModuleSearchOrdermoduleSearchOrder module search order
ErrorsNULL_ARGUMENT moduleSearchOrder is null
UNSUPPORTED moduleSearchOrder is not of this service
Compliancemandatory This 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.TypemoduleSearchRecordType a module search record type
Returnosid.course.syllabus.records.ModuleSearchRecord 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.