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

This session provides methods to retrieve Convocation to Academy mappings. A Convocation may appear in multiple Academies. Each Academy may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupConvocationAcademyMappings
Description

Tests if this user can perform lookups of convocation/academy mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeAcademyView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryAcademyView
Description

A complete view of the Convocation and Academy returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetConvocationIdsByAcademy
Description

Gets the list of Convocation Ids associated with an Academy.

Parametersosid.id.IdacademyId Id of an Academy.
Returnosid.id.IdListlist of related convocation Ids
ErrorsNOT_FOUND academyId is not found
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConvocationsByAcademy
Description

Gets the list of Convocations associated with an Academy.

Parametersosid.id.IdacademyId Id of an Academy
Returnosid.recognition.ConvocationListlist of related convocations
ErrorsNOT_FOUND academyId is not found
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConvocationIdsByAcademies
Description

Gets the list of Convocation Ids corresponding to a list of Academy objects.

Parametersosid.id.IdListacademyIdslist of academy Ids
Returnosid.id.IdListlist of convocation Ids
ErrorsNULL_ARGUMENT academyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConvocationsByAcademies
Description

Gets the list of Convocations corresponding to a list of Academies.

Parametersosid.id.IdListacademyIdslist of academy Ids
Returnosid.recognition.ConvocationListlist of convocations
ErrorsNULL_ARGUMENT academyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAcademyIdsByConvocation
Description

Gets the list of Academy Ids mapped to a Convocation.

Parametersosid.id.IdconvocationId Id of a Convocation
Returnosid.id.IdListlist of academy Ids
ErrorsNOT_FOUND convocationId is not found
NULL_ARGUMENT convocationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAcademiesByConvocation
Description

Gets the list of Academy objects mapped to a Convocation.

Parametersosid.id.IdconvocationId Id of a Convocation
Returnosid.recognition.AcademyListlist of academies
ErrorsNOT_FOUND convocationId is not found
NULL_ARGUMENT convocationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.