OSID Logo
OSID Specifications
course plan package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.plan.PlanCourseCatalogSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve Plan to CourseCatalog mappings. A Plan 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
MethodcanLookupPlanCourseCatalogMappings
Description

Tests if this user can perform lookups of plan/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 Plan 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.
MethodgetPlanIdsByCourseCatalog
Description

Gets the list of Plan Ids associated with an CourseCatalog.

Parametersosid.id.IdcourseCatalogId Id of an CourseCatalog.
Returnosid.id.IdListlist of related plan 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.
MethodgetPlansByCourseCatalog
Description

Gets the list of Plans associated with an CourseCatalog.

Parametersosid.id.IdcourseCatalogId Id of an CourseCatalog
Returnosid.course.plan.PlanListlist of related plans
ErrorsNOT_FOUND courseCatalogId is not found
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPlanIdsByCourseCatalogs
Description

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

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

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

Parametersosid.id.IdListcourseCatalogIdslist of course catalog Ids
Returnosid.course.plan.PlanListlist of plans
ErrorsNULL_ARGUMENT courseCatalogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogIdsByPlan
Description

Gets the list of CourseCatalog Ids mapped to a Plan.

Parametersosid.id.IdplanId Id of a Plan
Returnosid.id.IdListlist of course catalog Ids
ErrorsNOT_FOUND planId is not found
NULL_ARGUMENT planId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogsByPlan
Description

Gets the list of CourseCatalog objects mapped to a Plan.

Parametersosid.id.IdplanId Id of a Plan
Returnosid.course.CourseCatalogListlist of course catalogs
ErrorsNOT_FOUND planId is not found
NULL_ARGUMENT planId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.