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

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

MethodcanAssignAwardEntries
Description

Tests if this user can alter award 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.
MethodcanAssignAwardEntryToCourseCatalog
Description

Tests if this user can alter award 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 award 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.
MethodgetAssignableCourseCatalogIdsForAwardEntry
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
osid.id.IdawardEntryIdthe Id of the AwardEntry
Returnosid.id.IdListlist of assignable course catalog Ids
ErrorsNULL_ARGUMENT courseCatalogId or awardEntryId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignAwardEntryToCourseCatalog
Description

Adds an existing AwardEntry to a CourseCatalog.

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

Removes an AwardEntry from a CourseCatalog.

Parametersosid.id.IdawardEntryIdthe Id of the AwardEntry
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsNOT_FOUND awardEntryId or courseCatalogId not found or awardEntryId not assigned to courseCatalogId
NULL_ARGUMENT awardEntryId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignAwardEntryToCourseCatalog
Description

Moves an AwardEntry from one CourseCatalog to another. Mappings to other CourseCatalogs are unaffected.

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