OSID Logo
OSID Specifications
course package
Version 3.1.0
Interfaceosid.course.CourseSearchSession
Implementsosid.course.CourseQuerySession
Used Byosid.course.CourseManager
osid.course.CourseProxyManager
Description

This session provides methods for searching among Courses. 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.CourseSearch the course search
Compliancemandatory This 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.CourseSearchOrder the course search order
Compliancemandatory This method must be implemented.
MethodgetCoursesBySearch
Description

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

Parametersosid.course.CourseQuerycourseQuery the course query
osid.course.CourseSearchcourseSearch the course search
Returnosid.course.CourseSearchResults the course search results
ErrorsNULL_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
Compliancemandatory This method must be implemented.
MethodgetCourseQueryFromInspector
Description

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

Parametersosid.course.CourseQueryInspectorcourseQueryInspector a course query inspector
Returnosid.course.CourseQuery the course query
ErrorsNULL_ARGUMENT courseQueryInspector is null
UNSUPPORTED courseQueryInspector is not of this service
Compliancemandatory This method must be implemented.