Interface | osid.course.syllabus.ModuleSearchSession | ||
---|---|---|---|
Implements | osid.course.syllabus.ModuleQuerySession | ||
Description |
This session provides methods for searching Modules may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getModuleSearch | ||
Description |
Gets a module search. | ||
Return | osid.course.syllabus.ModuleSearch | the module search | |
Compliance | mandatory | This method must be implemented. | |
Method | getModuleSearchOrder | ||
Description |
Gets a module search order. The | ||
Return | osid.course.syllabus.ModuleSearchOrder | the module search order interface | |
Compliance | mandatory | This method must be implemented. | |
Method | getModulesBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.course.syllabus.ModuleQuery | moduleQuery | the module query |
osid.course.syllabus.ModuleSearch | moduleSearch | the module search | |
Return | osid.course.syllabus.ModuleSearchResults | the module search results | |
Errors | NULL_ARGUMENT | moduleQuery or moduleSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | moduleQuery or moduleSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getModuleQueryFromInspector | ||
Description |
Gets a module query from an inspector. The inspector is
available from an | ||
Parameters | osid.course.syllabus.ModuleQueryInspector | moduleQueryInspector | a module query inspector |
Return | osid.course.syllabus.ModuleQuery | the module query | |
Errors | NULL_ARGUMENT | moduleQueryInspector is null | |
UNSUPPORTED | moduleQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |