OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.CourseProgramAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to assign Courses to programs. A Course may appear in multiple Programs.

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

Tests if this user can alter program/course 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.
MethodcanAssignCourseToProgram
Description

Tests if this user can alter program/course 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 lookup operations to unauthorized users.

Parametersosid.id.IdprogramIdthe Id of the Program
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT programId is null
CompliancemandatoryThis method must be implemented.
MethodassignCourseToProgram
Description

Adds an existing Course to a program.

Parametersosid.id.IdcourseIdthe Id of the Course
osid.id.IdprogramIdthe Id of the Program
ErrorsALREADY_EXISTS courseId is already assigned to programId
NOT_FOUND courseId or programId not found
NULL_ARGUMENT courseId or programId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignCourseFromProgram
Description

Removes a Course from a Program.

Parametersosid.id.IdcourseIdthe Id of the Course
osid.id.IdprogramIdthe Id of the Program
ErrorsNOT_FOUND courseId or programId not found or courseId not assigned to programId
NULL_ARGUMENT courseId or programId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.