OSID Logo
OSID Specifications
recognition batch package
Version 3.1.0
Interfaceosid.recognition.batch.RecognitionBatchManager
Implementsosid.OsidManager
osid.recognition.batch.RecognitionBatchProfile
Used Byosid.recognition.RecognitionManager
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.ConferralBatchAdminSession a ConferralBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConferralBatchAdmin() is false
Complianceoptional This 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.IdacademyId the Id of the Academy
Returnosid.recognition.batch.ConferralBatchAdminSession a ConferralBatchAdminSession
ErrorsNOT_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
Complianceoptional This 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.AwardBatchAdminSession an AwardBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAwardBatchAdmin() is false
Complianceoptional This 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.IdacademyId the Id of the Academy
Returnosid.recognition.batch.AwardBatchAdminSession an AwardBatchAdminSession
ErrorsNOT_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
Complianceoptional This 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.ConvocationBatchAdminSession a ConvocationBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsConvocationBatchAdmin() is false
Complianceoptional This 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.IdacademyId the Id of the Academy
Returnosid.recognition.batch.ConvocationBatchAdminSession a ConvocationBatchAdminSession
ErrorsNOT_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
Complianceoptional This 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.AcademyBatchAdminSession a AcademyBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAcademyBatchAdmin() is false
Complianceoptional This method must be implemented if supportsAcademyBatchAdmin() is true.