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

This session provides methods to retrieve Docet to CourseCatalog mappings. An Docet may appear in multiple Course Catalogs. Each CourseCatalog may have its own authorizations governing who is allowed to look at it.

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
MethodcanLookupDocetCourseCatalogMappings
Description

Tests if this user can perform lookups of docet/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeCourseCatalogView
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.
MethodusePlenaryCourseCatalogView
Description

A complete view of the Docet and CourseCatalog 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.
MethodgetDocetIdsByCourseCatalog
Description

Gets the list of Docet Ids associated with an CourseCatalog.

Parametersosid.id.IdcourseCatalogId Id of an CourseCatalog.
Returnosid.id.IdListlist of related docet Ids
ErrorsNOT_FOUND courseCatalogId is not found
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDocetsByCourseCatalog
Description

Gets the list of Docets associated with an CourseCatalog.

Parametersosid.id.IdcourseCatalogId Id of an CourseCatalog
Returnosid.course.syllabus.DocetListlist of related docets
ErrorsNOT_FOUND courseCatalogId is not found
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDocetIdsByCourseCatalogs
Description

Gets the list of Docet Ids corresponding to a list of CourseCatalog objects.

Parametersosid.id.IdListcourseCatalogIdslist of course catalog Ids
Returnosid.id.IdListlist of docet Ids
ErrorsNULL_ARGUMENT courseCatalogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDocetsByCourseCatalogs
Description

Gets the list of Docets corresponding to a list of Course Catalogs.

Parametersosid.id.IdListcourseCatalogIdslist of course catalog Ids
Returnosid.course.syllabus.DocetListlist of docets
ErrorsNULL_ARGUMENT courseCatalogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogIdsByDocet
Description

Gets the list of CourseCatalog Ids mapped to an Docet.

Parametersosid.id.IddocetId Id of an Docet
Returnosid.id.IdListlist of course catalog Ids
ErrorsNOT_FOUND docetId is not found
NULL_ARGUMENT docetId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogsByDocet
Description

Gets the list of CourseCatalog objects mapped to an Docet.

Parametersosid.id.IddocetId Id of an Docet
Returnosid.course.CourseCatalogListlist of course catalogs
ErrorsNOT_FOUND docetId is not found
NULL_ARGUMENT docetId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.