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

This session provides methods to re-assign ProgramOfferings to CourseCatalogs. A ProgramOffering may appear in multiple CourseCatalog objects and removing the last reference to a ProgramOffering 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 ProgramOffering to another CourseCatalog is not a copy operation (eg: does not change its Id ).

MethodcanAssignProgramOfferings
Description

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

Tests if this user can alter program offering/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 lookup 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 program offering 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.
MethodgetAssignableCourseCtalogIdsForProgramOffering
Description

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

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

Adds an existing ProgramOffering to a CourseCatalog.

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

Removes a ProgramOffering from a CourseCatalog.

Parametersosid.id.IdprogramOfferingIdthe Id of the ProgramOffering
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsNOT_FOUND programOfferingId or courseCatalogId not found or programOfferingId not assigned to courseCatalogId
NULL_ARGUMENT programOfferingId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignProgramOfferingToCourseCatalog
Description

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

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