Interface | osid.recognition.RecognitionManager | ||
---|---|---|---|
Implements | osid.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:
The recognition manager also provides a profile for determing the supported search types supported by this service. | ||
Method | getConferralLookupSession | ||
Description |
Gets the | ||
Return | osid.recognition.ConferralLookupSession | a ConferralLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsConferralLookup() is false | ||
Compliance | optional | This method must be implemented if supportsConferralLookup()
is true. | |
Method | getConferralLookupSessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.ConferralLookupSession | a ConferralLookupSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsConferralLookup()
and supportsVisibleFederation() are true | |
Method | getConferralQuerySession | ||
Description |
Gets the | ||
Return | osid.recognition.ConferralQuerySession | a ConferralQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsConferralQuery() is false | ||
Compliance | optional | This method must be implemented if supportsConferralQuery()
is true. | |
Method | getConferralQuerySessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.ConferralQuerySession | a ConferralQuerySession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsConferralQuery()
and supportsVisibleFederation() are true | |
Method | getConferralSearchSession | ||
Description |
Gets the | ||
Return | osid.recognition.ConferralSearchSession | a ConferralSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsConferralSearch() is false | ||
Compliance | optional | This method must be implemented if supportsConferralSearch()
is true. | |
Method | getConferralSearchSessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.ConferralSearchSession | a ConferralSearchSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsConferralSearch()
and supportsVisibleFederation() are true | |
Method | getConferralAdminSession | ||
Description |
Gets the | ||
Return | osid.recognition.ConferralAdminSession | a ConferralAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsConferralAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsConferralAdmin()
is true. | |
Method | getConferralAdminSessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.ConferralAdminSession | a ConferralAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsConferralAdmin()
and supportsVisibleFederation() are true | |
Method | getConferralNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.recognition.ConferralReceiver | conferralReceiver | the receiver |
Return | osid.recognition.ConferralNotificationSession | a ConferralNotificationSession | |
Errors | NULL_ARGUMENT | conferralReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsConferralNotification() is false | ||
Compliance | optional | This method must be implemented if supportsConferralNotification()
is true. | |
Method | getConferralNotificationSessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.recognition.ConferralReceiver | conferralReceiver | the receiver |
osid.id.Id | academyId | the Id of the Academy | |
Return | osid.recognition.ConferralNotificationSession | a ConferralNotificationSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsConferralNotification()
and supportsVisibleFederation() are true | |
Method | getConferralAcademySession | ||
Description |
Gets the session for retrieving conferral to academy mappings. | ||
Return | osid.recognition.ConferralAcademySession | a ConferralAcademySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsConferralAcademy() is false | ||
Compliance | optional | This method must be implemented if supportsConferralAcademy()
is true. | |
Method | getConferralAcademyAssignmentSession | ||
Description |
Gets the session for assigning conferral to academy mappings. | ||
Return | osid.recognition.ConferralAcademyAssignmentSession | a ConferralAcademyAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsConferralAcademyAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsConferralAcademyAssignment() is true. | |
Method | getConferralSmartAcademySession | ||
Description |
Gets the session associated with the conferral smart academy for the given academy. | ||
Parameters | osid.id.Id | academyId | the Id of the academy |
Return | osid.recognition.ConferralSmartAcademySession | a ConferralSmartAcademySession | |
Errors | NOT_FOUND | conferralBookId not found | |
NULL_ARGUMENT | conferralBookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsConferralSmartAcademy() is false | ||
Compliance | optional | This method must be implemented if supportsConferralSmartAcademy()
is true. | |
Method | getAwardLookupSession | ||
Description |
Gets the | ||
Return | osid.recognition.AwardLookupSession | an AwardLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAwardLookup() is false | ||
Compliance | optional | This method must be implemented if supportsAwardLookup() is
true. | |
Method | getAwardLookupSessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.AwardLookupSession | an AwardLookupSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsAwardLookup() and
supportsVisibleFederation() are true | |
Method | getAwardQuerySession | ||
Description |
Gets the | ||
Return | osid.recognition.AwardQuerySession | an AwardQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAwardQuery() is false | ||
Compliance | optional | This method must be implemented if supportsAwardQuery() is
true. | |
Method | getAwardQuerySessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.AwardQuerySession | an AwardQuerySession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsAwardQuery() and
supportsVisibleFederation() are true | |
Method | getAwardSearchSession | ||
Description |
Gets the | ||
Return | osid.recognition.AwardSearchSession | an AwardSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAwardSearch() is false | ||
Compliance | optional | This method must be implemented if supportsAwardSearch() is
true. | |
Method | getAwardSearchSessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.AwardSearchSession | an AwardSearchSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsAwardSearch() and
supportsVisibleFederation() are true | |
Method | getAwardAdminSession | ||
Description |
Gets the | ||
Return | osid.recognition.AwardAdminSession | an AwardAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAwardAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsAwardAdmin() is
true. | |
Method | getAwardAdminSessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.AwardAdminSession | an AwardAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsAwardAdmin() and
supportsVisibleFederation() are true | |
Method | getAwardNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.recognition.AwardReceiver | awardReceiver | the receiver |
Return | osid.recognition.AwardNotificationSession | an AwardNotificationSession | |
Errors | NULL_ARGUMENT | awardReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAwardNotification() is false | ||
Compliance | optional | This method must be implemented if supportsAwardNotification()
is true. | |
Method | getAwardNotificationSessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.recognition.AwardReceiver | awardReceiver | the receiver |
osid.id.Id | academyId | the Id of the Academy | |
Return | osid.recognition.AwardNotificationSession | an AwardNotificationSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsAwardNotification()
and supportsVisibleFederation() are true | |
Method | getAwardAcademySession | ||
Description |
Gets the session for retrieving award to academy mappings. | ||
Return | osid.recognition.AwardAcademySession | an AwardAcademySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAwardAcademy() is false | ||
Compliance | optional | This method must be implemented if supportsAwardAcademy() is
true. | |
Method | getAwardAcademyAssignmentSession | ||
Description |
Gets the session for assigning award to academy mappings. | ||
Return | osid.recognition.AwardAcademyAssignmentSession | an AwardAcademyAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAwardAcademyAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsAwardAcademyAssignment()
is true. | |
Method | getAwardSmartAcademySession | ||
Description |
Gets the session associated with the award smart academy for the given academy. | ||
Parameters | osid.id.Id | academyId | the Id of the academy |
Return | osid.recognition.AwardSmartAcademySession | an AwardSmartAcademySession | |
Errors | NOT_FOUND | academyId not found | |
NULL_ARGUMENT | academyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAwardSmartAcademy() is false | ||
Compliance | optional | This method must be implemented if supportsAwardSmartAcademy()
is true. | |
Method | getConvocationLookupSession | ||
Description |
Gets the | ||
Return | osid.recognition.ConvocationLookupSession | a ConvocationLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsConvocationLookup() is false | ||
Compliance | optional | This method must be implemented if supportsConvocationLookup()
is true. | |
Method | getConvocationLookupSessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.ConvocationLookupSession | a ConvocationLookupSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsConvocationLookup()
and supportsVisibleFederation() are true | |
Method | getConvocationQuerySession | ||
Description |
Gets the | ||
Return | osid.recognition.ConvocationQuerySession | a ConvocationQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsConvocationQuery() is false | ||
Compliance | optional | This method must be implemented if supportsConvocationQuery()
is true. | |
Method | getConvocationQuerySessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.ConvocationQuerySession | a ConvocationQuerySession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsConvocationQuery()
and supportsVisibleFederation() are true | |
Method | getConvocationSearchSession | ||
Description |
Gets the | ||
Return | osid.recognition.ConvocationSearchSession | a ConvocationSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsConvocationSearch() is false | ||
Compliance | optional | This method must be implemented if supportsConvocationSearch()
is true. | |
Method | getConvocationSearchSessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.ConvocationSearchSession | a ConvocationSearchSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsConvocationSearch()
and supportsVisibleFederation() are true | |
Method | getConvocationAdminSession | ||
Description |
Gets the | ||
Return | osid.recognition.ConvocationAdminSession | a ConvocationAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsConvocationAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsConvocationAdmin()
is true. | |
Method | getConvocationAdminSessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.ConvocationAdminSession | a ConvocationAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsConvocationAdmin()
and supportsVisibleFederation() are true | |
Method | getConvocationNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.recognition.ConvocationReceiver | convocationReceiver | the receiver |
Return | osid.recognition.ConvocationNotificationSession | a ConvocationNotificationSession | |
Errors | NULL_ARGUMENT | convocationReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsConvocationNotification() is false | ||
Compliance | optional | This method must be implemented if supportsConvocationNotification()
is true. | |
Method | getConvocationNotificationSessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.recognition.ConvocationReceiver | convocationReceiver | the receiver |
osid.id.Id | academyId | the Id of the Academy | |
Return | osid.recognition.ConvocationNotificationSession | a ConvocationNotificationSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsConvocationNotification()
and supportsVisibleFederation() are true | |
Method | getConvocationAcademySession | ||
Description |
Gets the session for retrieving convocation to academy mappings. | ||
Return | osid.recognition.ConvocationAcademySession | a ConvocationAcademySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsConvocationAcademy() is false | ||
Compliance | optional | This method must be implemented if supportsConvocationAcademy()
is true. | |
Method | getConvocationAcademyAssignmentSession | ||
Description |
Gets the session for assigning convocation to academy mappings. | ||
Return | osid.recognition.ConvocationAcademyAssignmentSession | a ConvocationAcademyAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsConvocationAcademyAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsConvocationAcademyAssignment() is true. | |
Method | getConvocationSmartAcademySession | ||
Description |
Gets the session associated with the convocation smart academy for the given academy. | ||
Parameters | osid.id.Id | academyId | the Id of the convocation book |
Return | osid.recognition.ConvocationSmartAcademySession | a ConvocationSmartAcademySession | |
Errors | NOT_FOUND | convocationBookId not found | |
NULL_ARGUMENT | convocationBookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsConvocationSmartAcademy() is false | ||
Compliance | optional | This method must be implemented if supportsConvocationSmartAcademy()
is true. | |
Method | getAcademyLookupSession | ||
Description |
Gets the | ||
Return | osid.recognition.AcademyLookupSession | an AcademyLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAcademyLookup() is false | ||
Compliance | optional | This method must be implemented if supportsAcademyLookup()
is true. | |
Method | getAcademyQuerySession | ||
Description |
Gets the | ||
Return | osid.recognition.AcademyQuerySession | an AcademyQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAcademyQuery() is false | ||
Compliance | optional | This method must be implemented if supportsAcademyQuery() is
true. | |
Method | getAcademySearchSession | ||
Description |
Gets the | ||
Return | osid.recognition.AcademySearchSession | an AcademySearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAcademySearch() is false | ||
Compliance | optional | This method must be implemented if supportsAcademySearch()
is true. | |
Method | getAcademyAdminSession | ||
Description |
Gets the | ||
Return | osid.recognition.AcademyAdminSession | an AcademyAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAcademyAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsAcademyAdmin() is
true. | |
Method | getAcademyNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.recognition.AcademyReceiver | academyReceiver | the receiver |
Return | osid.recognition.AcademyNotificationSession | an AcademyNotificationSession | |
Errors | NULL_ARGUMENT | academyReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAcademyNotification() is false | ||
Compliance | optional | This method must be implemented if supportsAcademyNotification()
is true. | |
Method | getAcademyHierarchySession | ||
Description |
Gets the | ||
Return | osid.recognition.AcademyHierarchySession | an AcademyHierarchySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAcademyHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsAcademyHierarchy()
is true. | |
Method | getAcademyHierarchyDesignSession | ||
Description |
Gets the | ||
Return | osid.recognition.AcademyHierarchyDesignSession | an AcademyHierarchyDesignSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAcademyHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsAcademyHierarchyDesign()
is true. | |
Method | getRecognitionBatchManager | ||
Description |
Gets a | ||
Return | osid.recognition.batch.RecognitionBatchManager | a RecognitionBatchManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRecognitionBatch() is false | ||
Compliance | optional | This method must be implemented if supportsRecognitionBatch()
is true. |