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

This session provides methods for retrieving Academy objects. The Academy represents a collection of conferrals, awards, and convocations.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

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

Returnboolean false if lookup methods are 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 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.
MethodgetAcademy
Description

Gets the Academy specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Academy may have a different Id than requested, such as the case where a duplicate Id was assigned to an Academy and retained for compatibility.

Parametersosid.id.IdjouralId Id of the Academy
Returnosid.recognition.Academythe academy
ErrorsNOT_FOUND academyId not found
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetAcademiesByIds
Description

Gets an AcademyList corresponding to the given IdList. In plenary mode, the returned list contains all of the academies specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Academies may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListacademyIdsthe list of Ids to retrieve
Returnosid.recognition.AcademyListthe returned Academy list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT academyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAcademiesByGenusType
Description

Gets an AcademyList corresponding to the given academy genus Type which does not include academies of genus types derived from the specified Type. In plenary mode, the returned list contains all known academies or an error results. Otherwise, the returned list may contain only those academies that are accessible through this session.

Parametersosid.type.TypeacademyGenusTypean academy genus type
Returnosid.recognition.AcademyListthe returned Academy list
ErrorsNULL_ARGUMENT academyGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAcademiesByParentGenusType
Description

Gets an AcademyList corresponding to the given academy genus Type and include any additional academies with genus types derived from the specified Type. In plenary mode, the returned list contains all known academies or an error results. Otherwise, the returned list may contain only those academies that are accessible through this session.

Parametersosid.type.TypeacademyGenusTypean academy genus type
Returnosid.recognition.AcademyListthe returned Academy list
ErrorsNULL_ARGUMENT academyGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAcademiesByRecordType
Description

Gets an AcademyList containing the given academy record Type. In plenary mode, the returned list contains all known academies or an error results. Otherwise, the returned list may contain only those academies that are accessible through this session.

Parametersosid.type.TypeacademyRecordTypean academy record type
Returnosid.recognition.AcademyListthe returned Academy list
ErrorsNULL_ARGUMENT academyRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAcademiesByProvider
Description

Gets an AcademyList by the given provdier . In plenary mode, the returned list contains all known academies or an error results. Otherwise, the returned list may contain only those academies that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.recognition.AcademyListthe returned Academy list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAcademies
Description

Gets all Academies. In plenary mode, the returned list contains all known academies or an error results. Otherwise, the returned list may contain only those academies that are accessible through this session.

Returnosid.recognition.AcademyLista list of Academies
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.