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

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

MethodcanAssignCourses
Description

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

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

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

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

Adds an existing Credential to a CourseCatalog.

Parametersosid.id.IdcredentialIdthe Id of the Credential
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsALREADY_EXISTS credentialId isalready assigned to courseCatalogId
NOT_FOUND credentialId or courseCatalogId not found
NULL_ARGUMENT credentialId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignCredentialFromCourseCatalog
Description

Removes a Credential from a CourseCatalog.

Parametersosid.id.IdcredentialIdthe Id of the Credential
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsNOT_FOUND credentialId or courseCatalogId not found or credentialId not assigned to courseCatalogId
NULL_ARGUMENT credentialId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignCredentialToCourseCatalog
Description

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

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