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

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

MethodcanAssignCredentialEntries
Description

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

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

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

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

Adds an existing CredentialEntry to a CourseCatalog.

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

Removes a CredentialEntry from a CourseCatalog.

Parametersosid.id.IdcredentialEntryIdthe Id of the CredentialEntry
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsNOT_FOUND credentialEntryId or courseCatalogId not found or credentialEntryId not assigned to courseCatalogId
NULL_ARGUMENT credentialEntryId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignCredentialEntryToCourseCatalog
Description

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

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