Interface | osid.course.syllabus.ModuleSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing module searches. | ||
Method | searchAmongModules | ||
Description |
Execute this search among the given list of modules. | ||
Parameters | osid.id.IdList | moduleIds | list of modules |
Errors | NULL_ARGUMENT | moduleIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderModuleResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.course.syllabus.ModuleSearchOrder | moduleSearchOrder | module search order |
Errors | NULL_ARGUMENT | moduleSearchOrder is null | |
UNSUPPORTED | moduleSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getModuleSearchRecord | ||
Description |
Gets the module search record corresponding to the
given module search record | ||
Parameters | osid.type.Type | moduleSearchRecordType | a module search record type |
Return | osid.course.syllabus.records.ModuleSearchRecord | the module search record | |
Errors | NULL_ARGUMENT | moduleSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(moduleSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |