OSID Logo
OSID Specifications
recognition batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.batch.RecognitionBatchManager
Implementsosid.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:

  • ConferralBatchAdminSession: a session to create, modify and delete Conferrals in bulk
  • AwardBatchAdminSession: a session to create, modify and delete Awards in bulk
  • ConvocationBatchAdminSession: a session to create, modify and delete Convocations in bulk
  • AcademyBatchAdminSession: a session to create, modify and delete Academy in bulk

MethodgetConferralBatchAdminSession
Description

Gets the OsidSession associated with the bulk conferral administration service.

Returnosid.recognition.batch.ConferralBatchAdminSessiona ConferralBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConferralBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsConferralBatchAdmin() is true.
MethodgetConferralBatchAdminSessionForAcademy
Description

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

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

Gets the OsidSession associated with the bulk award administration service.

Returnosid.recognition.batch.AwardBatchAdminSessionan AwardBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAwardBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAwardBatchAdmin() is true.
MethodgetAwardBatchAdminSessionForAcademy
Description

Gets the OsidSession associated with the bulk award administration service for the given academy.

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

Gets the OsidSession associated with the bulk convocation administration service.

Returnosid.recognition.batch.ConvocationBatchAdminSessiona ConvocationBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsConvocationBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsConvocationBatchAdmin() is true.
MethodgetConvocationBatchAdminSessionForAcademy
Description

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

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

Gets the OsidSession associated with the bulk academy administration service.

Returnosid.recognition.batch.AcademyBatchAdminSessiona AcademyBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAcademyBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAcademyBatchAdmin() is true.