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

This session defines methods for retrieving syllabi.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated course catalog view: All syllabus methods in this session operate, retrieve and pertain to syllabi defined explicitly in the current course catalog. Using an isolated view is useful for managing syllabi with the SyllabusAdminSession.
  • federated course catalog view: All syllabus lookup methods in this session operate, retrieve and pertain to all syllabi defined in this course catalog and any other course catalogs implicitly available in this course catalog through course catalog inheritence.

The methods useFederatedCourseCatalogView() and useIsolatedCourseCatalogView() behave as a radio group and one should be selected before invoking any lookup methods.

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.
MethodcanLookupSyllabi
Description

Tests if this user can lookup syllabi. 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 opt not to offer these operations.

Returnboolean false if syllabus lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeSyllabusView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenarySyllabusView
Description

A complete view of the Syllabus returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is 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.
MethodgetSyllabus
Description

Gets the Syllabus specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Syllabus may have a different Id than requested, such as the case where a duplicate Id was assigned to a Syllabus and retained for compatibility.

Parametersosid.id.IdsyllabusIdthe Id of the Syllabus to retrieve
Returnosid.course.syllabus.Syllabusthe returned Syllabus
ErrorsNOT_FOUNDno Syllabus found with the given Id
NULL_ARGUMENT syllabusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSyllabiByIds
Description

Gets a SyllabusList corresponding to the given IdList. In plenary mode, the returned list contains all of the syllabi specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible syllabi may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListsyllabusIdsthe list of Ids to retrieve
Returnosid.course.syllabus.SyllabusListthe returned Syllabus list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT syllabusIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSyllabiByGenusType
Description

Gets a SyllabusList corresponding to the given syllabus genus Type which does not include syllabi of genus types derived from the specified Type. In plenary mode, the returned list contains all known syllabi or an error results. Otherwise, the returned list may contain only those syllabi that are accessible through this session.

Parametersosid.type.TypesyllabusGenusTypea syllabus genus type
Returnosid.course.syllabus.SyllabusListthe returned Syllabus list
ErrorsNULL_ARGUMENT syllabusGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSyllabiByParentGenusType
Description

Gets a SyllabusList corresponding to the given syllabus genus Type and include any additional syllabi with genus types derived from the specified Type. In plenary mode, the returned list contains all known syllabi or an error results. Otherwise, the returned list may contain only those syllabi that are accessible through this session.

Parametersosid.type.TypesyllabusGenusTypea syllabus genus type
Returnosid.course.syllabus.SyllabusListthe returned Syllabus list
ErrorsNULL_ARGUMENT syllabusGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSyllabiByRecordType
Description

Gets a SyllabusList containing the given syllabus record Type. In plenary mode, the returned list contains all known syllabi or an error results. Otherwise, the returned list may contain only those syllabi that are accessible through this session.

Parametersosid.type.TypesyllabusRecordTypea syllabus record type
Returnosid.course.syllabus.SyllabusListthe returned Syllabus list
ErrorsNULL_ARGUMENT syllabusRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSyllabiForCourse
Description

Gets a SyllabusList for the given course . In plenary mode, the returned list contains all known syllabi or an error results. Otherwise, the returned list may contain only those syllabi that are accessible through this session.

Parametersosid.id.IdcourseIda course Id
Returnosid.course.syllabus.SyllabusListthe returned Syllabus list
ErrorsNULL_ARGUMENT courseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSyllabi
Description

Gets all syllabi. In plenary mode, the returned list contains all known syllabi or an error results. Otherwise, the returned list may contain only those syllabi that are accessible through this session.

Returnosid.course.syllabus.SyllabusLista list of syllabi
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.