Interface | osid.course.CourseSearchSession | ||
---|---|---|---|
Implements | osid.course.CourseQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Courses may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getCourseSearch | ||
Description |
Gets a course search. | ||
Return | osid.course.CourseSearch | the course search | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseSearchOrder | ||
Description |
Gets a course search order. The | ||
Return | osid.course.CourseSearchOrder | the course search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getCoursesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.course.CourseQuery | courseQuery | the course query |
osid.course.CourseSearch | courseSearch | the course search | |
Return | osid.course.CourseSearchResults | the course search results | |
Errors | NULL_ARGUMENT | courseQuery or courseSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | courseQuery or courseSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseQueryFromInspector | ||
Description |
Gets a course query from an inspector. The inspector is
available from a | ||
Parameters | osid.course.CourseQueryInspector | courseQueryInspector | a course query inspector |
Return | osid.course.CourseQuery | the course query | |
Errors | NULL_ARGUMENT | courseQueryInspector is null | |
UNSUPPORTED | courseQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |