Interface | osid.recognition.batch.RecognitionBatchManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.recognition.batch.RecognitionBatchProfile | |||
Description |
The recognition batch manager provides access to recognition batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getConferralBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.recognition.batch.ConferralBatchAdminSession | a ConferralBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsConferralBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsConferralBatchAdmin()
is true. | |
Method | getConferralBatchAdminSessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.batch.ConferralBatchAdminSession | a ConferralBatchAdminSession | |
Errors | NOT_FOUND | no Academy found by the given Id | |
NULL_ARGUMENT | academyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsConferralBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsConferralBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getAwardBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.recognition.batch.AwardBatchAdminSession | an AwardBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAwardBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsAwardBatchAdmin()
is true. | |
Method | getAwardBatchAdminSessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.batch.AwardBatchAdminSession | an AwardBatchAdminSession | |
Errors | NOT_FOUND | no Academy found by the given Id | |
NULL_ARGUMENT | academyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAwardBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsAwardBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getConvocationBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.recognition.batch.ConvocationBatchAdminSession | a ConvocationBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsConvocationBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsConvocationBatchAdmin()
is true. | |
Method | getConvocationBatchAdminSessionForAcademy | ||
Description |
Gets the | ||
Parameters | osid.id.Id | academyId | the Id of the Academy |
Return | osid.recognition.batch.ConvocationBatchAdminSession | a ConvocationBatchAdminSession | |
Errors | NOT_FOUND | no Academy found by the given Id | |
NULL_ARGUMENT | academyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsConvocationBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsConvocationBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getAcademyBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.recognition.batch.AcademyBatchAdminSession | a AcademyBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAcademyBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsAcademyBatchAdmin()
is true. |