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

This session provides methods to re-assign Plans to Course Catalogs. A Plan may map to multiple CourseCatalogs and removing the last reference to a Plan is the equivalent of deleting it. Each CourseCatalog may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Plan to another CourseCatalog is not a copy operation (eg: does not change its Id ).

MethodcanAssignPlans
Description

Tests if this user can alter plan/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignPlansToCourseCatalog
Description

Tests if this user can alter plan/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT courseCatalogId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCourseCatalogIds
Description

Gets a list of course catalogs including and under the given course catalog node in which any plan can be assigned.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.id.IdListlist of assignable course catalog Ids
ErrorsNULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCourseCatalogIdsForPlan
Description

Gets a list of course catalogs including and under the given course catalog node in which a specific plan can be assigned.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
osid.id.IdplanIdthe Id of the Plan
Returnosid.id.IdListlist of assignable course catalog Ids
ErrorsNULL_ARGUMENT courseCatalogId or planId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignPlanToCourseCatalog
Description

Adds an existing Plan to an CourseCatalog.

Parametersosid.id.IdplanIdthe Id of the Plan
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsALREADY_EXISTS planId is already assigned to courseCatalogId
NOT_FOUND planId or courseCatalogId not found
NULL_ARGUMENT planId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignPlanFromCourseCatalog
Description

Removes a Plan from an CourseCatalog.

Parametersosid.id.IdplanIdthe Id of the Plan
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsNOT_FOUND planId or courseCatalogId not found or planId not assigned to courseCatalogId
NULL_ARGUMENT planId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignPlanToCourseCatalog
Description

Moves a Plan from one CourseCatalog to another. Mappings to other CourseCatalogs are unaffected.

Parametersosid.id.IdplanIdthe Id of the Plan
osid.id.IdfromCourseCatalogIdthe Id of the current CourseCatalog
osid.id.IdtoCourseCatalogIdthe Id of the destination CourseCatalog
ErrorsNOT_FOUND planId, fromCourseCatalogId, or toCourseCatalogId not found or planId not mapped to fromCourseCatalogId
NULL_ARGUMENT planId, fromCourseCatalogId, or toCourseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.