OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.RecognitionProfile
Implementsosid.OsidProfile
Description

The recognition profile describes the interoperability among recognition services.

MethodsupportsVisibleFederation
Description

Tests if any award federation is exposed. Federation is exposed when a specific award may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of awards appears as a single award.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConferralLookup
Description

Tests for the availability of a conferral lookup service.

Returnboolean true if conferral lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConferralQuery
Description

Tests if querying conferrals is available.

Returnboolean true if conferral query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConferralSearch
Description

Tests if searching for conferrals is available.

Returnboolean true if conferral search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConferralAdmin
Description

Tests if searching for conferrals is available.

Returnboolean true if conferral search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConferralNotification
Description

Tests if conferral notification is available.

Returnboolean true if conferral notification is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConferralAcademy
Description

Tests if a conferral to academy lookup session is available.

Returnboolean true if conferral academy lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConferralAcademyAssignment
Description

Tests if a conferral to academy assignment session is available.

Returnboolean true if conferral academy assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConferralSmartAcademy
Description

Tests if a conferral smart academy session is available.

Returnboolean true if conferral smart academy is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAwardLookup
Description

Tests for the availability of an award lookup service.

Returnboolean true if award lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAwardQuery
Description

Tests if querying awards is available.

Returnboolean true if award query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAwardSearch
Description

Tests if searching for awards is available.

Returnboolean true if award search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAwardAdmin
Description

Tests for the availability of an award administrative service for creating and deleting awards.

Returnboolean true if award administration is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAwardNotification
Description

Tests for the availability of an award notification service.

Returnboolean true if award notification is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsAwardAcademy
Description

Tests if an award to academy lookup session is available.

Returnboolean true if award academy lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAwardAcademyAssignment
Description

Tests if an award to academy assignment session is available.

Returnboolean true if award academy assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAwardSmartAcademy
Description

Tests if an award smart academy session is available.

Returnboolean true if award smart academy is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConvocation
Description

Tests for the availability of a convocation service for getting available convocations for a resource.

Returnboolean true if convocation is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConvocationLookup
Description

Tests for the availability of a convocation lookup service.

Returnboolean true if convocation lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConvocationQuery
Description

Tests if querying convocations is available.

Returnboolean true if convocation query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConvocationSearch
Description

Tests if searching for convocations is available.

Returnboolean true if convocation search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConvocationAdmin
Description

Tests if searching for convocations is available.

Returnboolean true if convocation search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConvocationNotification
Description

Tests if convocation notification is available.

Returnboolean true if convocation notification is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConvocationAcademy
Description

Tests if a convocation to academy lookup session is available.

Returnboolean true if convocation academy lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConvocationAcademyAssignment
Description

Tests if a convocation to academy assignment session is available.

Returnboolean true if convocation academy assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsConvocationSmartAcademy
Description

Tests if a convocation smart academy session is available.

Returnboolean true if convocation smart academy is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAcademyLookup
Description

Tests for the availability of an academy lookup service.

Returnboolean true if academy lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAcademyQuery
Description

Tests if querying academies is available.

Returnboolean true if academy query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAcademySearch
Description

Tests if searching for academies is available.

Returnboolean true if academy search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAcademyAdmin
Description

Tests for the availability of an academy administrative service for creating and deleting academies.

Returnboolean true if academy administration is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAcademyNotification
Description

Tests for the availability of an academy notification service.

Returnboolean true if academy notification is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsAcademyHierarchy
Description

Tests for the availability of an academy hierarchy traversal service.

Returnboolean true if academy hierarchy traversal is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAcademyHierarchyDesign
Description

Tests for the availability of an academy hierarchy design service.

Returnboolean true if academy hierarchy design is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsRecognitionBatch
Description

Tests for the availability of a recognition batch service.

Returnboolean true if a recognition batch service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetConferralRecordTypes
Description

Gets the supported Conferral record types.

Returnosid.type.TypeLista list containing the supported conferral record types
CompliancemandatoryThis method must be implemented.
MethodsupportsConferralRecordType
Description

Tests if the given Conferral record type is supported.

Parametersosid.type.TypeconferralRecordTypea Type indicating a Conferral record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT conferralRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetConferralSearchRecordTypes
Description

Gets the supported conferral search record types.

Returnosid.type.TypeLista list containing the supported conferral search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsConferralSearchRecordType
Description

Tests if the given conferral search record type is supported.

Parametersosid.type.TypeconferralSearchRecordTypea Type indicating a conferral record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT conferralSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetAwardRecordTypes
Description

Gets the supported Award record types.

Returnosid.type.TypeLista list containing the supported award record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAwardRecordType
Description

Tests if the given Award record type is supported.

Parametersosid.type.TypeawardRecordTypea Type indicating a Award record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT awardRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetAwardSearchRecordTypes
Description

Gets the supported award search record types.

Returnosid.type.TypeLista list containing the supported award search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAwardSearchRecordType
Description

Tests if the given award search record type is supported.

Parametersosid.type.TypeawardSearchRecordTypea Type indicating an award record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT awardSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetConvocationRecordTypes
Description

Gets the supported Convocation record types.

Returnosid.type.TypeLista list containing the supported convocation record types
CompliancemandatoryThis method must be implemented.
MethodsupportsConvocationRecordType
Description

Tests if the given Convocation record type is supported.

Parametersosid.type.TypeconvocationRecordTypea Type indicating a Convocation record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT convocationRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetConvocationSearchRecordTypes
Description

Gets the supported convocation search record types.

Returnosid.type.TypeLista list containing the supported convocation search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsConvocationSearchRecordType
Description

Tests if the given convocation search record type is supported.

Parametersosid.type.TypeconvocationSearchRecordTypea Type indicating a convocation record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT convocationSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetAcademyRecordTypes
Description

Gets the supported academy record types.

Returnosid.type.TypeLista list containing the supported academy record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAcademyRecordType
Description

Tests if the given academy record type is supported.

Parametersosid.type.TypeacademyRecordTypea Type indicating an academy record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT academyRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetAcademySearchRecordTypes
Description

Gets the supported academy search record types.

Returnosid.type.TypeLista list containing the supported academy search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAcademySearchRecordType
Description

Tests if the given academy search record type is supported.

Parametersosid.type.TypeacademySearchRecordTypea Type indicating an academy record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT academySearchRecordType is null
CompliancemandatoryThis method must be implemented.