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

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

MethodcanAssignTerms
Description

Tests if this user can alter term/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.
MethodcanAssignTermsToCourseCatalog
Description

Tests if this user can alter term/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 term 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.
MethodgetAssignableCourseCatalogIdsForTerm
Description

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

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

Adds an existing Term to a CourseCatalog.

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

Removes a Term from a CourseCatalog.

Parametersosid.id.IdtermIdthe Id of the Term
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsNOT_FOUND termId or courseCatalogId not found or termId not assigned to courseCatalogId
NULL_ARGUMENT termId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignTermToCourseCatalog
Description

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

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