OSID Logo
OSID Specifications
course syllabus package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.syllabus.SyllabusQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching Syllabus objects. The search query is constructed using the SyllabusQuery. The syllabus record Type also specifies the record for the docet query.

Syllabi may have a query record indicated by their respective record types. The query record is accessed via the SyllabusQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetCourseCatalogId
Description

Gets the CourseCatalog Id associated with this session.

Returnosid.id.Idthe CourseCatalog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalog
Description

Gets the CourseCatalog associated with this session.

Returnosid.course.CourseCatalogthe course catalog
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchSyllabi
Description

Tests if this user can perform susbcription searches. 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 wish to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCourseCatalogView
Description

Federates the view for methods in this session. A federated view will include syllabi in course catalogs which are children of this course catalog in the course catalog hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCourseCatalogView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.

CompliancemandatoryThis method is must be implemented.
MethodgetSyllabusQuery
Description

Gets a syllabus query.

Returnosid.course.syllabus.SyllabusQuerythe syllabus query
CompliancemandatoryThis method must be implemented.
MethodgetSyllabiByQuery
Description

Gets a list of syllabi matching the given syllabus query.

Parametersosid.course.syllabus.SyllabusQuerysyllabusQuerythe syllabus query
Returnosid.course.syllabus.SyllabusListthe returned SyllabusList
ErrorsNULL_ARGUMENT syllabusQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED syllabusQuery is not of this service
CompliancemandatoryThis method must be implemented.