OSID Logo
OSID Specifications
recognition package
Version 3.1.0
Interfaceosid.recognition.ConvocationAcademyAssignmentSession
Implementsosid.OsidSession
Used Byosid.recognition.RecognitionManager
osid.recognition.RecognitionProxyManager
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
Compliancemandatory This 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.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 convocation 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.
MethodgetAssignableAcademyIdsForConvocation
Description

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

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

Adds an existing Convocation to an Academy.

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

Removes a Convocation from an Academy.

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

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

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