OSID Logo
OSID Specifications
recognition package
Version 3.1.0
Interfaceosid.recognition.ConferralAcademyAssignmentSession
Implementsosid.OsidSession
Used Byosid.recognition.RecognitionManager
osid.recognition.RecognitionProxyManager
Description

This session provides methods to re-assign Conferrals to Academies. A Conferral may map to multiple Academies and removing the last reference to a Conferral 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 a Conferral to another Academy is not a copy operation (eg: does not change its Id).

MethodcanAssignConferrals
Description

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

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

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

Parametersosid.id.IdacademyId the Id of the Academy
osid.id.IdconferralId the Id of the Conferral
Returnosid.id.IdList list of assignable academy Ids
ErrorsNULL_ARGUMENT academyId or conferralId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignConferralToAcademy
Description

Adds an existing Conferral to an Academy.

Parametersosid.id.IdconferralId the Id of the Conferral
osid.id.IdacademyId the Id of the Academy
ErrorsALREADY_EXISTS conferralId is already assigned to academyId
NOT_FOUND conferralId or academyId not found
NULL_ARGUMENT conferralId or academyId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignConferralFromAcademy
Description

Removes a Conferral from an Academy.

Parametersosid.id.IdconferralId the Id of the Conferral
osid.id.IdacademyId the Id of the Academy
ErrorsNOT_FOUND conferralId or academyId not found or conferralId not assigned to academyId
NULL_ARGUMENT conferralId or academyId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignConferralToAcademy
Description

Moves a Conferral from one Academy to another. Mappings to other Academies are unaffected.

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