OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.AwardAcademyAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign Awards to Academies. An Award may map to multiple Academies and removing the last reference to an Award is the equivalent of deleting it. Each Academy may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an Award to another Academy is not a copy operation (eg: does not change its Id ).

MethodcanAssignAwards
Description

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

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

Parametersosid.id.IdacademyIdthe Id of the Academy
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT academyId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableAcademyIds
Description

Gets a list of academies including and under the given academy node in which any award can be assigned.

Parametersosid.id.IdacademyIdthe Id of the Academy
Returnosid.id.IdListlist of assignable academy Ids
ErrorsNULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableAcademyIdsForAward
Description

Gets a list of academies including and under the given academy node in which a specific award can be assigned.

Parametersosid.id.IdacademyIdthe Id of the Academy
osid.id.IdawardIdthe Id of the Award
Returnosid.id.IdListlist of assignable academy Ids
ErrorsNULL_ARGUMENT academyId or awardId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignAwardToAcademy
Description

Adds an existing Award to an Academy.

Parametersosid.id.IdawardIdthe Id of the Award
osid.id.IdacademyIdthe Id of the Academy
ErrorsALREADY_EXISTS awardId is already assigned to academyId
NOT_FOUND awardId or academyId not found
NULL_ARGUMENT awardId or academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignAwardFromAcademy
Description

Removes an Award from an Academy.

Parametersosid.id.IdawardIdthe Id of the Award
osid.id.IdacademyIdthe Id of the Academy
ErrorsNOT_FOUND awardId or academyId not found or awardId not asigned to academyId
NULL_ARGUMENT awardId or academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.