OSID Logo
OSID Specifications
course package
Version 3.1.0
Interfaceosid.course.CourseCatalogQuerySession
Implementsosid.OsidSession
Implemented Byosid.course.CourseCatalogSearchSession
Used Byosid.course.CourseManager
osid.course.CourseProxyManager
Description

This session provides methods for searching among CourseCatalogs. The search query is constructed using the CourseCatalogQuery.

This session defines views that offer differing behaviors for searching.

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

Course catalogs may have a query record indicated by their respective record types. The query record is accessed via the CourseCatalogQuery.

MethodcanSearchCourseCatalogs
Description

Tests if this user can perform CourseCatalog lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodgetCourseCatalogQuery
Description

Gets a course catalog query.

Returnosid.course.CourseCatalogQuery the course catalog query
Compliancemandatory This method must be implemented.
MethodgetCourseCatalogsByQuery
Description

Gets a list of CourseCatalogs matching the given course catalog query.

Parametersosid.course.CourseCatalogQuerycourseCatalogQuery the course catalog query
Returnosid.course.CourseCatalogList the returned CourseCatalogList
ErrorsNULL_ARGUMENT courseCatalogQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED courseCatalogQuery is not of this service
Compliancemandatory This method must be implemented.