OSID Logo
OSID Specifications
recognition package
Version 3.1.0
Interfaceosid.recognition.AwardAcademyAssignmentSession
Implementsosid.OsidSession
Used Byosid.recognition.RecognitionManager
osid.recognition.RecognitionProxyManager
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
Compliancemandatory This 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.IdacademyId the Id of the Academy
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT academyId is null
Compliancemandatory This 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.IdacademyId the Id of the Academy
Returnosid.id.IdList list of assignable academy Ids
ErrorsNULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This 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.IdacademyId the Id of the Academy
osid.id.IdawardId the Id of the Award
Returnosid.id.IdList list of assignable academy Ids
ErrorsNULL_ARGUMENT academyId or awardId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignAwardToAcademy
Description

Adds an existing Award to an Academy.

Parametersosid.id.IdawardId the Id of the Award
osid.id.IdacademyId the 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_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignAwardFromAcademy
Description

Removes an Award from an Academy.

Parametersosid.id.IdawardId the Id of the Award
osid.id.IdacademyId the 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_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignAwardToAcademy
Description

Moves an Award from one Academy to another. Mappings to other Academies are unaffected.

Parametersosid.id.IdawardId the Id of the Award
osid.id.IdfromAcademyId the Id of the current Academy
osid.id.IdtoAcademyId the Id of the destination Academy
ErrorsALREADY_EXISTS awardId already assigned to toAcademyId
NOT_FOUND awardId, fromAcademyId, or toAcademyId not found or awardId not mapped to fromAcademyId
NULL_ARGUMENT awardId, fromAcademyId, or toAcademyId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.