OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.CourseSearchSession
Implementsosid.course.CourseQuerySession
Description

This session provides methods for searching among Course objects. The search query is constructed using the CourseQuery.

getCoursesByQuery() is the basic search method and returns a list of Courses. A more advanced search may be performed with getCoursesBySearch(). It accepts a CourseSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getCoursesBySearch() returns a CourseSearchResults that can be used to access the resulting CourseList or be used to perform a search within the result set through CourseSearch.

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include courses in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
  • isolated course catalog view: searches are restricted to courses in this course catalog

Courses may have a query record indicated by their respective record types. The query record is accessed via the CourseQuery.

MethodgetCourseSearch
Description

Gets a course search.

Returnosid.course.CourseSearchthe course search
CompliancemandatoryThis method must be implemented.
MethodgetCourseSearchOrder
Description

Gets a course search order. The CourseSearchOrder is supplied to a CourseSearch to specify the ordering of results.

Returnosid.course.CourseSearchOrderthe course search order
CompliancemandatoryThis method must be implemented.
MethodgetCoursesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.course.CourseQuerycourseQuerythe course query
osid.course.CourseSearchcourseSearchthe course search
Returnosid.course.CourseSearchResultsthe course search results
ErrorsNULL_ARGUMENT courseQuery or courseSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED courseQuery or courseSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCourseQueryFromInspector
Description

Gets a course query from an inspector. The inspector is available from a CourseSearchResults.

Parametersosid.course.CourseQueryInspectorcourseQueryInspectora course query inspector
Returnosid.course.CourseQuerythe course query
ErrorsNULL_ARGUMENT courseQueryInspector is null
UNSUPPORTED courseQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.