OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.RecognitionManager
Implementsosid.OsidManager
osid.recognition.RecognitionProfile
Description

The recognition manager provides access to conferral sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • ConferralLookupSession: a session to lookup conferrals
  • ConferralQuerySession: a session to query conferrals
  • ConferralSearchSession: a session to search conferrals
  • ConferralAdminSession: a session to manage conferrals
  • ConferralNotificationSession: a session to subscribe to notifications of conferral changes
  • ConferralAcademySession: a session to lookup conferral academy mappings
  • ConferralAcademyAssignmentSession: a session to manage conferral academy mappings
  • ConferralSmartAcademySession: a session to manage smart academies of conferrals
  • AwardLookupSession: a session to retrieve awards
  • AwardQuerySession: a session to query awards
  • AwardSearchSession: a session to search for awards
  • AwardAdminSession: a session to create, update and delete awards
  • AwardNotificationSession: a session to receive notifications for changes in awards
  • AwardAcademySession: a session to lookup award academy mappings
  • AwardAcademyAssignmentSession: a session to manage award academy mappings
  • AwardSmartAcademySession: a session to manage smart academies of awards
  • ConvocationSession : a session to get available convocations for a resource
  • ConvocationLookupSession: a session to lookup convocations
  • ConvocationQuerySession: a session to query convocations
  • ConvocationSearchSession: a session to search convocations
  • ConvocationAdminSession: a session to manage convocations
  • ConvocationNotificationSession: a session to subscribe to notifications of convocation changes
  • ConvocationAcademySession: a session to lookup convocation academy mappings
  • ConvocationAcademyAssignmentSession: a session to manage convocation academy mappings
  • ConvocationSmartAcademySession: a session to manage smart academies of convocations
  • AcademyLookupSession: a session to retrieve academies
  • AcademyQuerySession: a session to query academies
  • AcademySearchSession: a session to search for academies
  • AcademyAdminSession: a session to create, update and delete academies
  • AcademyNotificationSession: a session to receive notifications for changes in academies
  • AcademyHierarchyTraversalSession: a session to traverse hierarchies of academies
  • AcademyHierarchyDesignSession: a session to manage hierarchies of academies

The recognition manager also provides a profile for determing the supported search types supported by this service.

MethodgetConferralLookupSession
Description

Gets the OsidSession associated with the conferral lookup service.

Returnosid.recognition.ConferralLookupSessiona ConferralLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConferralLookup() is false
ComplianceoptionalThis method must be implemented if supportsConferralLookup() is true.
MethodgetConferralLookupSessionForAcademy
Description

Gets the OsidSession associated with the conferral lookup service for the given academy.

Parametersosid.id.IdacademyIdthe Id of the Academy
Returnosid.recognition.ConferralLookupSessiona ConferralLookupSession
ErrorsNOT_FOUNDno Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConferralLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsConferralLookup() and supportsVisibleFederation() are true
MethodgetConferralQuerySession
Description

Gets the OsidSession associated with the conferral query service.

Returnosid.recognition.ConferralQuerySessiona ConferralQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConferralQuery() is false
ComplianceoptionalThis method must be implemented if supportsConferralQuery() is true.
MethodgetConferralQuerySessionForAcademy
Description

Gets the OsidSession associated with the conferral query service for the given academy.

Parametersosid.id.IdacademyIdthe Id of the Academy
Returnosid.recognition.ConferralQuerySessiona ConferralQuerySession
ErrorsNOT_FOUNDno Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConferralQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsConferralQuery() and supportsVisibleFederation() are true
MethodgetConferralSearchSession
Description

Gets the OsidSession associated with the conferral search service.

Returnosid.recognition.ConferralSearchSessiona ConferralSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConferralSearch() is false
ComplianceoptionalThis method must be implemented if supportsConferralSearch() is true.
MethodgetConferralSearchSessionForAcademy
Description

Gets the OsidSession associated with the conferral search service for the given academy.

Parametersosid.id.IdacademyIdthe Id of the Academy
Returnosid.recognition.ConferralSearchSessiona ConferralSearchSession
ErrorsNOT_FOUNDno Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConferralSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsConferralSearch() and supportsVisibleFederation() are true
MethodgetConferralAdminSession
Description

Gets the OsidSession associated with the conferral administration service.

Returnosid.recognition.ConferralAdminSessiona ConferralAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConferralAdmin() is false
ComplianceoptionalThis method must be implemented if supportsConferralAdmin() is true.
MethodgetConferralAdminSessionForAcademy
Description

Gets the OsidSession associated with the conferral administration service for the given academy.

Parametersosid.id.IdacademyIdthe Id of the Academy
Returnosid.recognition.ConferralAdminSessiona ConferralAdminSession
ErrorsNOT_FOUNDno Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConferralAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsConferralAdmin() and supportsVisibleFederation() are true
MethodgetConferralNotificationSession
Description

Gets the OsidSession associated with the conferral notification service.

Parametersosid.recognition.ConferralReceiverconferralReceiverthe receiver
Returnosid.recognition.ConferralNotificationSessiona ConferralNotificationSession
ErrorsNULL_ARGUMENT conferralReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConferralNotification() is false
ComplianceoptionalThis method must be implemented if supportsConferralNotification() is true.
MethodgetConferralNotificationSessionForAcademy
Description

Gets the OsidSession associated with the conferral notification service for the given academy.

Parametersosid.recognition.ConferralReceiverconferralReceiverthe receiver
osid.id.IdacademyIdthe Id of the Academy
Returnosid.recognition.ConferralNotificationSessiona ConferralNotificationSession
ErrorsNOT_FOUNDno Academy found by the given Id
NULL_ARGUMENT conferralReceiver or academyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConferralNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsConferralNotification() and supportsVisibleFederation() are true
MethodgetConferralAcademySession
Description

Gets the session for retrieving conferral to academy mappings.

Returnosid.recognition.ConferralAcademySessiona ConferralAcademySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConferralAcademy() is false
ComplianceoptionalThis method must be implemented if supportsConferralAcademy() is true.
MethodgetConferralAcademyAssignmentSession
Description

Gets the session for assigning conferral to academy mappings.

Returnosid.recognition.ConferralAcademyAssignmentSessiona ConferralAcademyAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConferralAcademyAssignment() is false
ComplianceoptionalThis method must be implemented if supportsConferralAcademyAssignment() is true.
MethodgetConferralSmartAcademySession
Description

Gets the session associated with the conferral smart academy for the given academy.

Parametersosid.id.IdacademyIdthe Id of the academy
Returnosid.recognition.ConferralSmartAcademySessiona ConferralSmartAcademySession
ErrorsNOT_FOUND conferralBookId not found
NULL_ARGUMENT conferralBookId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConferralSmartAcademy() is false
ComplianceoptionalThis method must be implemented if supportsConferralSmartAcademy() is true.
MethodgetAwardLookupSession
Description

Gets the OsidSession associated with the award lookup service.

Returnosid.recognition.AwardLookupSessionan AwardLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAwardLookup() is false
ComplianceoptionalThis method must be implemented if supportsAwardLookup() is true.
MethodgetAwardLookupSessionForAcademy
Description

Gets the OsidSession associated with the award lookup service for the given academy.

Parametersosid.id.IdacademyIdthe Id of the Academy
Returnosid.recognition.AwardLookupSessionan AwardLookupSession
ErrorsNOT_FOUNDno Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAwardLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAwardLookup() and supportsVisibleFederation() are true
MethodgetAwardQuerySession
Description

Gets the OsidSession associated with the award query service.

Returnosid.recognition.AwardQuerySessionan AwardQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAwardQuery() is false
ComplianceoptionalThis method must be implemented if supportsAwardQuery() is true.
MethodgetAwardQuerySessionForAcademy
Description

Gets the OsidSession associated with the award query service for the given academy.

Parametersosid.id.IdacademyIdthe Id of the Academy
Returnosid.recognition.AwardQuerySessionan AwardQuerySession
ErrorsNOT_FOUNDno Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAwardQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAwardQuery() and supportsVisibleFederation() are true
MethodgetAwardSearchSession
Description

Gets the OsidSession associated with the award search service.

Returnosid.recognition.AwardSearchSessionan AwardSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAwardSearch() is false
ComplianceoptionalThis method must be implemented if supportsAwardSearch() is true.
MethodgetAwardSearchSessionForAcademy
Description

Gets the OsidSession associated with the award search service for the given academy.

Parametersosid.id.IdacademyIdthe Id of the Academy
Returnosid.recognition.AwardSearchSessionan AwardSearchSession
ErrorsNOT_FOUNDno Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAwardSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAwardSearch() and supportsVisibleFederation() are true
MethodgetAwardAdminSession
Description

Gets the OsidSession associated with the award administrative service.

Returnosid.recognition.AwardAdminSessionan AwardAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAwardAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAwardAdmin() is true.
MethodgetAwardAdminSessionForAcademy
Description

Gets the OsidSession associated with the award administrative service for the given academy.

Parametersosid.id.IdacademyIdthe Id of the Academy
Returnosid.recognition.AwardAdminSessionan AwardAdminSession
ErrorsNOT_FOUNDno Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAwardAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAwardAdmin() and supportsVisibleFederation() are true
MethodgetAwardNotificationSession
Description

Gets the OsidSession associated with the award notification service.

Parametersosid.recognition.AwardReceiverawardReceiverthe receiver
Returnosid.recognition.AwardNotificationSessionan AwardNotificationSession
ErrorsNULL_ARGUMENT awardReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAwardNotification() is false
ComplianceoptionalThis method must be implemented if supportsAwardNotification() is true.
MethodgetAwardNotificationSessionForAcademy
Description

Gets the OsidSession associated with the award notification service for the given academy.

Parametersosid.recognition.AwardReceiverawardReceiverthe receiver
osid.id.IdacademyIdthe Id of the Academy
Returnosid.recognition.AwardNotificationSessionan AwardNotificationSession
ErrorsNOT_FOUNDno Academy found by the given Id
NULL_ARGUMENT awardReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAwardNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAwardNotification() and supportsVisibleFederation() are true
MethodgetAwardAcademySession
Description

Gets the session for retrieving award to academy mappings.

Returnosid.recognition.AwardAcademySessionan AwardAcademySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAwardAcademy() is false
ComplianceoptionalThis method must be implemented if supportsAwardAcademy() is true.
MethodgetAwardAcademyAssignmentSession
Description

Gets the session for assigning award to academy mappings.

Returnosid.recognition.AwardAcademyAssignmentSessionan AwardAcademyAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAwardAcademyAssignment() is false
ComplianceoptionalThis method must be implemented if supportsAwardAcademyAssignment() is true.
MethodgetAwardSmartAcademySession
Description

Gets the session associated with the award smart academy for the given academy.

Parametersosid.id.IdacademyIdthe Id of the academy
Returnosid.recognition.AwardSmartAcademySessionan AwardSmartAcademySession
ErrorsNOT_FOUND academyId not found
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAwardSmartAcademy() is false
ComplianceoptionalThis method must be implemented if supportsAwardSmartAcademy() is true.
MethodgetConvocationLookupSession
Description

Gets the OsidSession associated with the convocation lookup service.

Returnosid.recognition.ConvocationLookupSessiona ConvocationLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConvocationLookup() is false
ComplianceoptionalThis method must be implemented if supportsConvocationLookup() is true.
MethodgetConvocationLookupSessionForAcademy
Description

Gets the OsidSession associated with the convocation lookup service for the given academy.

Parametersosid.id.IdacademyIdthe Id of the Academy
Returnosid.recognition.ConvocationLookupSessiona ConvocationLookupSession
ErrorsNOT_FOUNDno Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConvocationLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsConvocationLookup() and supportsVisibleFederation() are true
MethodgetConvocationQuerySession
Description

Gets the OsidSession associated with the convocation query service.

Returnosid.recognition.ConvocationQuerySessiona ConvocationQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConvocationQuery() is false
ComplianceoptionalThis method must be implemented if supportsConvocationQuery() is true.
MethodgetConvocationQuerySessionForAcademy
Description

Gets the OsidSession associated with the convocation query service for the given academy.

Parametersosid.id.IdacademyIdthe Id of the Academy
Returnosid.recognition.ConvocationQuerySessiona ConvocationQuerySession
ErrorsNOT_FOUNDno Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConvocationQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsConvocationQuery() and supportsVisibleFederation() are true
MethodgetConvocationSearchSession
Description

Gets the OsidSession associated with the convocation search service.

Returnosid.recognition.ConvocationSearchSessiona ConvocationSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConvocationSearch() is false
ComplianceoptionalThis method must be implemented if supportsConvocationSearch() is true.
MethodgetConvocationSearchSessionForAcademy
Description

Gets the OsidSession associated with the convocation search service for the given academy.

Parametersosid.id.IdacademyIdthe Id of the Academy
Returnosid.recognition.ConvocationSearchSessiona ConvocationSearchSession
ErrorsNOT_FOUNDno Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConvocationSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsConvocationSearch() and supportsVisibleFederation() are true
MethodgetConvocationAdminSession
Description

Gets the OsidSession associated with the convocation administration service.

Returnosid.recognition.ConvocationAdminSessiona ConvocationAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConvocationAdmin() is false
ComplianceoptionalThis method must be implemented if supportsConvocationAdmin() is true.
MethodgetConvocationAdminSessionForAcademy
Description

Gets the OsidSession associated with the convocation administration service for the given academy.

Parametersosid.id.IdacademyIdthe Id of the Academy
Returnosid.recognition.ConvocationAdminSessiona ConvocationAdminSession
ErrorsNOT_FOUNDno Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConvocationAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsConvocationAdmin() and supportsVisibleFederation() are true
MethodgetConvocationNotificationSession
Description

Gets the OsidSession associated with the convocation notification service.

Parametersosid.recognition.ConvocationReceiverconvocationReceiverthe receiver
Returnosid.recognition.ConvocationNotificationSessiona ConvocationNotificationSession
ErrorsNULL_ARGUMENT convocationReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConvocationNotification() is false
ComplianceoptionalThis method must be implemented if supportsConvocationNotification() is true.
MethodgetConvocationNotificationSessionForAcademy
Description

Gets the OsidSession associated with the convocation notification service for the given academy.

Parametersosid.recognition.ConvocationReceiverconvocationReceiverthe receiver
osid.id.IdacademyIdthe Id of the Academy
Returnosid.recognition.ConvocationNotificationSessiona ConvocationNotificationSession
ErrorsNOT_FOUNDno Academy found by the given Id
NULL_ARGUMENT convocationReceiver or academyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConvocationNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsConvocationNotification() and supportsVisibleFederation() are true
MethodgetConvocationAcademySession
Description

Gets the session for retrieving convocation to academy mappings.

Returnosid.recognition.ConvocationAcademySessiona ConvocationAcademySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConvocationAcademy() is false
ComplianceoptionalThis method must be implemented if supportsConvocationAcademy() is true.
MethodgetConvocationAcademyAssignmentSession
Description

Gets the session for assigning convocation to academy mappings.

Returnosid.recognition.ConvocationAcademyAssignmentSessiona ConvocationAcademyAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConvocationAcademyAssignment() is false
ComplianceoptionalThis method must be implemented if supportsConvocationAcademyAssignment() is true.
MethodgetConvocationSmartAcademySession
Description

Gets the session associated with the convocation smart academy for the given academy.

Parametersosid.id.IdacademyIdthe Id of the convocation book
Returnosid.recognition.ConvocationSmartAcademySessiona ConvocationSmartAcademySession
ErrorsNOT_FOUND convocationBookId not found
NULL_ARGUMENT convocationBookId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConvocationSmartAcademy() is false
ComplianceoptionalThis method must be implemented if supportsConvocationSmartAcademy() is true.
MethodgetAcademyLookupSession
Description

Gets the OsidSession associated with the academy lookup service.

Returnosid.recognition.AcademyLookupSessionan AcademyLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAcademyLookup() is false
ComplianceoptionalThis method must be implemented if supportsAcademyLookup() is true.
MethodgetAcademyQuerySession
Description

Gets the OsidSession associated with the academy query service.

Returnosid.recognition.AcademyQuerySessionan AcademyQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAcademyQuery() is false
ComplianceoptionalThis method must be implemented if supportsAcademyQuery() is true.
MethodgetAcademySearchSession
Description

Gets the OsidSession associated with the academy search service.

Returnosid.recognition.AcademySearchSessionan AcademySearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAcademySearch() is false
ComplianceoptionalThis method must be implemented if supportsAcademySearch() is true.
MethodgetAcademyAdminSession
Description

Gets the OsidSession associated with the academy administrative service.

Returnosid.recognition.AcademyAdminSessionan AcademyAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAcademyAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAcademyAdmin() is true.
MethodgetAcademyNotificationSession
Description

Gets the OsidSession associated with the academy notification service.

Parametersosid.recognition.AcademyReceiveracademyReceiverthe receiver
Returnosid.recognition.AcademyNotificationSessionan AcademyNotificationSession
ErrorsNULL_ARGUMENT academyReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAcademyNotification() is false
ComplianceoptionalThis method must be implemented if supportsAcademyNotification() is true.
MethodgetAcademyHierarchySession
Description

Gets the OsidSession associated with the academy hierarchy service.

Returnosid.recognition.AcademyHierarchySessionan AcademyHierarchySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAcademyHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsAcademyHierarchy() is true.
MethodgetAcademyHierarchyDesignSession
Description

Gets the OsidSession associated with the academy hierarchy design service.

Returnosid.recognition.AcademyHierarchyDesignSessionan AcademyHierarchyDesignSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAcademyHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsAcademyHierarchyDesign() is true.
MethodgetRecognitionBatchManager
Description

Gets a RecognitionBatchManager.

Returnosid.recognition.batch.RecognitionBatchManagera RecognitionBatchManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecognitionBatch() is false
ComplianceoptionalThis method must be implemented if supportsRecognitionBatch() is true.