OSID Logo
OSID Specifications
recognition package
Version 3.1.0
Interfaceosid.recognition.RecognitionManager
Implementsosid.OsidManager
osid.recognition.RecognitionProfile
Used Byosid.orchestration.OrchestrationManager
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.ConferralLookupSession a ConferralLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConferralLookup() is false
Complianceoptional This 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.IdacademyId the Id of the Academy
Returnosid.recognition.ConferralLookupSession a ConferralLookupSession
ErrorsNOT_FOUND no Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConferralLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsConferralLookup() and supportsVisibleFederation() are true
MethodgetConferralQuerySession
Description

Gets the OsidSession associated with the conferral query service.

Returnosid.recognition.ConferralQuerySession a ConferralQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConferralQuery() is false
Complianceoptional This 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.IdacademyId the Id of the Academy
Returnosid.recognition.ConferralQuerySession a ConferralQuerySession
ErrorsNOT_FOUND no Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConferralQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsConferralQuery() and supportsVisibleFederation() are true
MethodgetConferralSearchSession
Description

Gets the OsidSession associated with the conferral search service.

Returnosid.recognition.ConferralSearchSession a ConferralSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConferralSearch() is false
Complianceoptional This 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.IdacademyId the Id of the Academy
Returnosid.recognition.ConferralSearchSession a ConferralSearchSession
ErrorsNOT_FOUND no Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConferralSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsConferralSearch() and supportsVisibleFederation() are true
MethodgetConferralAdminSession
Description

Gets the OsidSession associated with the conferral administration service.

Returnosid.recognition.ConferralAdminSession a ConferralAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConferralAdmin() is false
Complianceoptional This 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.IdacademyId the Id of the Academy
Returnosid.recognition.ConferralAdminSession a ConferralAdminSession
ErrorsNOT_FOUND no Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConferralAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsConferralAdmin() and supportsVisibleFederation() are true
MethodgetConferralNotificationSession
Description

Gets the OsidSession associated with the conferral notification service.

Parametersosid.recognition.ConferralReceiverconferralReceiver the receiver
Returnosid.recognition.ConferralNotificationSession a ConferralNotificationSession
ErrorsNULL_ARGUMENT conferralReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConferralNotification() is false
Complianceoptional This 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.ConferralReceiverconferralReceiver the receiver
osid.id.IdacademyId the Id of the Academy
Returnosid.recognition.ConferralNotificationSession a ConferralNotificationSession
ErrorsNOT_FOUND no Academy found by the given Id
NULL_ARGUMENT conferralReceiver or academyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConferralNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsConferralNotification() and supportsVisibleFederation() are true
MethodgetConferralAcademySession
Description

Gets the session for retrieving conferral to academy mappings.

Returnosid.recognition.ConferralAcademySession a ConferralAcademySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConferralAcademy() is false
Complianceoptional This method must be implemented if supportsConferralAcademy() is true.
MethodgetConferralAcademyAssignmentSession
Description

Gets the session for assigning conferral to academy mappings.

Returnosid.recognition.ConferralAcademyAssignmentSession a ConferralAcademyAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConferralAcademyAssignment() is false
Complianceoptional This 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.IdacademyId the Id of the academy
Returnosid.recognition.ConferralSmartAcademySession a ConferralSmartAcademySession
ErrorsNOT_FOUND conferralBookId not found
NULL_ARGUMENT conferralBookId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConferralSmartAcademy() is false
Complianceoptional This method must be implemented if supportsConferralSmartAcademy() is true.
MethodgetAwardLookupSession
Description

Gets the OsidSession associated with the award lookup service.

Returnosid.recognition.AwardLookupSession an AwardLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAwardLookup() is false
Complianceoptional This 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.IdacademyId the Id of the Academy
Returnosid.recognition.AwardLookupSession an AwardLookupSession
ErrorsNOT_FOUND no Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAwardLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAwardLookup() and supportsVisibleFederation() are true
MethodgetAwardQuerySession
Description

Gets the OsidSession associated with the award query service.

Returnosid.recognition.AwardQuerySession an AwardQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAwardQuery() is false
Complianceoptional This 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.IdacademyId the Id of the Academy
Returnosid.recognition.AwardQuerySession an AwardQuerySession
ErrorsNOT_FOUND no Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAwardQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAwardQuery() and supportsVisibleFederation() are true
MethodgetAwardSearchSession
Description

Gets the OsidSession associated with the award search service.

Returnosid.recognition.AwardSearchSession an AwardSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAwardSearch() is false
Complianceoptional This 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.IdacademyId the Id of the Academy
Returnosid.recognition.AwardSearchSession an AwardSearchSession
ErrorsNOT_FOUND no Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAwardSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAwardSearch() and supportsVisibleFederation() are true
MethodgetAwardAdminSession
Description

Gets the OsidSession associated with the award administrative service.

Returnosid.recognition.AwardAdminSession an AwardAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAwardAdmin() is false
Complianceoptional This 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.IdacademyId the Id of the Academy
Returnosid.recognition.AwardAdminSession an AwardAdminSession
ErrorsNOT_FOUND no Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAwardAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAwardAdmin() and supportsVisibleFederation() are true
MethodgetAwardNotificationSession
Description

Gets the OsidSession associated with the award notification service.

Parametersosid.recognition.AwardReceiverawardReceiver the receiver
Returnosid.recognition.AwardNotificationSession an AwardNotificationSession
ErrorsNULL_ARGUMENT awardReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAwardNotification() is false
Complianceoptional This 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.AwardReceiverawardReceiver the receiver
osid.id.IdacademyId the Id of the Academy
Returnosid.recognition.AwardNotificationSession an AwardNotificationSession
ErrorsNOT_FOUND no Academy found by the given Id
NULL_ARGUMENT awardReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAwardNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAwardNotification() and supportsVisibleFederation() are true
MethodgetAwardAcademySession
Description

Gets the session for retrieving award to academy mappings.

Returnosid.recognition.AwardAcademySession an AwardAcademySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAwardAcademy() is false
Complianceoptional This method must be implemented if supportsAwardAcademy() is true.
MethodgetAwardAcademyAssignmentSession
Description

Gets the session for assigning award to academy mappings.

Returnosid.recognition.AwardAcademyAssignmentSession an AwardAcademyAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAwardAcademyAssignment() is false
Complianceoptional This 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.IdacademyId the Id of the academy
Returnosid.recognition.AwardSmartAcademySession an AwardSmartAcademySession
ErrorsNOT_FOUND academyId not found
NULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAwardSmartAcademy() is false
Complianceoptional This method must be implemented if supportsAwardSmartAcademy() is true.
MethodgetConvocationLookupSession
Description

Gets the OsidSession associated with the convocation lookup service.

Returnosid.recognition.ConvocationLookupSession a ConvocationLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConvocationLookup() is false
Complianceoptional This 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.IdacademyId the Id of the Academy
Returnosid.recognition.ConvocationLookupSession a ConvocationLookupSession
ErrorsNOT_FOUND no Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConvocationLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsConvocationLookup() and supportsVisibleFederation() are true
MethodgetConvocationQuerySession
Description

Gets the OsidSession associated with the convocation query service.

Returnosid.recognition.ConvocationQuerySession a ConvocationQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConvocationQuery() is false
Complianceoptional This 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.IdacademyId the Id of the Academy
Returnosid.recognition.ConvocationQuerySession a ConvocationQuerySession
ErrorsNOT_FOUND no Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConvocationQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsConvocationQuery() and supportsVisibleFederation() are true
MethodgetConvocationSearchSession
Description

Gets the OsidSession associated with the convocation search service.

Returnosid.recognition.ConvocationSearchSession a ConvocationSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConvocationSearch() is false
Complianceoptional This 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.IdacademyId the Id of the Academy
Returnosid.recognition.ConvocationSearchSession a ConvocationSearchSession
ErrorsNOT_FOUND no Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConvocationSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsConvocationSearch() and supportsVisibleFederation() are true
MethodgetConvocationAdminSession
Description

Gets the OsidSession associated with the convocation administration service.

Returnosid.recognition.ConvocationAdminSession a ConvocationAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConvocationAdmin() is false
Complianceoptional This 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.IdacademyId the Id of the Academy
Returnosid.recognition.ConvocationAdminSession a ConvocationAdminSession
ErrorsNOT_FOUND no Academy found by the given Id
NULL_ARGUMENT academyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConvocationAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsConvocationAdmin() and supportsVisibleFederation() are true
MethodgetConvocationNotificationSession
Description

Gets the OsidSession associated with the convocation notification service.

Parametersosid.recognition.ConvocationReceiverconvocationReceiver the receiver
Returnosid.recognition.ConvocationNotificationSession a ConvocationNotificationSession
ErrorsNULL_ARGUMENT convocationReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConvocationNotification() is false
Complianceoptional This 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.ConvocationReceiverconvocationReceiver the receiver
osid.id.IdacademyId the Id of the Academy
Returnosid.recognition.ConvocationNotificationSession a ConvocationNotificationSession
ErrorsNOT_FOUND no Academy found by the given Id
NULL_ARGUMENT convocationReceiver or academyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConvocationNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsConvocationNotification() and supportsVisibleFederation() are true
MethodgetConvocationAcademySession
Description

Gets the session for retrieving convocation to academy mappings.

Returnosid.recognition.ConvocationAcademySession a ConvocationAcademySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConvocationAcademy() is false
Complianceoptional This method must be implemented if supportsConvocationAcademy() is true.
MethodgetConvocationAcademyAssignmentSession
Description

Gets the session for assigning convocation to academy mappings.

Returnosid.recognition.ConvocationAcademyAssignmentSession a ConvocationAcademyAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConvocationAcademyAssignment() is false
Complianceoptional This 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.IdacademyId the Id of the convocation book
Returnosid.recognition.ConvocationSmartAcademySession a ConvocationSmartAcademySession
ErrorsNOT_FOUND convocationBookId not found
NULL_ARGUMENT convocationBookId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConvocationSmartAcademy() is false
Complianceoptional This method must be implemented if supportsConvocationSmartAcademy() is true.
MethodgetAcademyLookupSession
Description

Gets the OsidSession associated with the academy lookup service.

Returnosid.recognition.AcademyLookupSession an AcademyLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAcademyLookup() is false
Complianceoptional This method must be implemented if supportsAcademyLookup() is true.
MethodgetAcademyQuerySession
Description

Gets the OsidSession associated with the academy query service.

Returnosid.recognition.AcademyQuerySession an AcademyQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAcademyQuery() is false
Complianceoptional This method must be implemented if supportsAcademyQuery() is true.
MethodgetAcademySearchSession
Description

Gets the OsidSession associated with the academy search service.

Returnosid.recognition.AcademySearchSession an AcademySearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAcademySearch() is false
Complianceoptional This method must be implemented if supportsAcademySearch() is true.
MethodgetAcademyAdminSession
Description

Gets the OsidSession associated with the academy administrative service.

Returnosid.recognition.AcademyAdminSession an AcademyAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAcademyAdmin() is false
Complianceoptional This method must be implemented if supportsAcademyAdmin() is true.
MethodgetAcademyNotificationSession
Description

Gets the OsidSession associated with the academy notification service.

Parametersosid.recognition.AcademyReceiveracademyReceiver the receiver
Returnosid.recognition.AcademyNotificationSession an AcademyNotificationSession
ErrorsNULL_ARGUMENT academyReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAcademyNotification() is false
Complianceoptional This method must be implemented if supportsAcademyNotification() is true.
MethodgetAcademyHierarchySession
Description

Gets the OsidSession associated with the academy hierarchy service.

Returnosid.recognition.AcademyHierarchySession an AcademyHierarchySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAcademyHierarchy() is false
Complianceoptional This method must be implemented if supportsAcademyHierarchy() is true.
MethodgetAcademyHierarchyDesignSession
Description

Gets the OsidSession associated with the academy hierarchy design service.

Returnosid.recognition.AcademyHierarchyDesignSession an AcademyHierarchyDesignSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAcademyHierarchyDesign() is false
Complianceoptional This method must be implemented if supportsAcademyHierarchyDesign() is true.
MethodgetRecognitionBatchManager
Description

Gets a RecognitionBatchManager.

Returnosid.recognition.batch.RecognitionBatchManager a RecognitionBatchManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecognitionBatch() is false
Complianceoptional This method must be implemented if supportsRecognitionBatch() is true.