Interface | osid.course.syllabus.ModuleSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getModules | ||
Description |
Gets the module list resulting from a search. | ||
Return | osid.course.syllabus.ModuleList | the module list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getModuleQueryInspector | ||
Description |
Gets the inspector for the query to examine the terns used in the search. | ||
Return | osid.course.syllabus.ModuleQueryInspector | the module query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getModuleSearchResultsRecord | ||
Description |
Gets the module search results record corresponding to
the given module search record | ||
Parameters | osid.type.Type | moduleSearchRecordType | a module search record type |
Return | osid.course.syllabus.records.ModuleSearchResultsRecord | 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. |