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

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

MethodcanAssignConvocations
Description

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

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

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

Parametersosid.id.IdacademyIdthe Id of the Academy
osid.id.IdconvocationIdthe Id of the Convocation
Returnosid.id.IdListlist of assignable academy Ids
ErrorsNULL_ARGUMENT academyId or convocationId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignConvocationToAcademy
Description

Adds an existing Convocation to an Academy.

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

Removes a Convocation from an Academy.

Parametersosid.id.IdconvocationIdthe Id of the Convocation
osid.id.IdacademyIdthe Id of the Academy
ErrorsNOT_FOUND convocationId or academyId not found or convocationId not assigned to academyId
NULL_ARGUMENT convocationId or academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.