OSID Logo
OSID Specifications
course program batch package
Version 3.1.0
Interfaceosid.course.program.batch.CourseProgramBatchManager
Implementsosid.OsidManager
osid.course.program.batch.CourseProgramBatchProfile
Used Byosid.course.program.CourseProgramManager
Description

The course program batch manager provides access to course program batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • ProgramBatchAdminSession: a session to create, modify and delete programs in bulk
  • ProgramOfferingBatchAdminSession: a session to create, modify and delete program offerings in bulk
  • CredentialBatchAdminSession: a session to create, modify and delete cerdentials in bulk
  • EnrollmentBatchAdminSession: a session to create, modify and delete enrollments in bulk
MethodgetProgramBatchAdminSession
Description

Gets the OsidSession associated with the bulk program administration service.

Returnosid.course.program.batch.ProgramBatchAdminSession a ProgramBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProgramBatchAdmin() is false
Complianceoptional This method must be implemented if supportsProgramBatchAdmin() is true.
MethodgetProgramBatchAdminSessionForCourseCatalog
Description

Gets the OsidSession associated with the bulk program administration service for the given course catalog.

Parametersosid.id.IdcourseCatalogId the Id of the CourseCatalog
Returnosid.course.program.batch.ProgramBatchAdminSession a ProgramBatchAdminSession
ErrorsNOT_FOUND no CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProgramBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProgramBatchAdmin() and supportsVisibleFederation() are true
MethodgetProgramOfferingBatchAdminSession
Description

Gets the OsidSession associated with the bulk program offering administration service.

Returnosid.course.program.batch.ProgramOfferingBatchAdminSession a ProgramOfferingBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProgramOfferingBatchAdmin() is false
Complianceoptional This method must be implemented if supportsProgramOfferingBatchAdmin() is true.
MethodgetProgramOfferingBatchAdminSessionForCourseCatalog
Description

Gets the OsidSession associated with the bulk program offering administration service for the given course catalog.

Parametersosid.id.IdcourseCatalogId the Id of the CourseCatalog
Returnosid.course.program.batch.ProgramOfferingBatchAdminSession a ProgramOfferingBatchAdminSession
ErrorsNOT_FOUND no CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProgramOfferingBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProgramOfferingBatchAdmin() and supportsVisibleFederation() are true
MethodgetCredentialBatchAdminSession
Description

Gets the OsidSession associated with the bulk credential administration service.

Returnosid.course.program.batch.CredentialBatchAdminSession a CredentialBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCredentialBatchAdmin() is false
Complianceoptional This method must be implemented if supportsCredentialBatchAdmin() is true.
MethodgetCredentialBatchAdminSessionForCourseCatalog
Description

Gets the OsidSession associated with the bulk credential administration service for the given course catalog.

Parametersosid.id.IdcourseCatalogId the Id of the CourseCatalog
Returnosid.course.program.batch.CredentialBatchAdminSession a CredentialBatchAdminSession
ErrorsNOT_FOUND no CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCredentialBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCredentialBatchAdmin() and supportsVisibleFederation() are true
MethodgetEnrollmentBatchAdminSession
Description

Gets the OsidSession associated with the bulk enrollment administration service.

Returnosid.course.program.batch.EnrollmentBatchAdminSession an EnrollmentBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEnrollmentBatchAdmin() is false
Complianceoptional This method must be implemented if supportsEnrollmentBatchAdmin() is true.
MethodgetEnrollmentBatchAdminSessionForCourseCatalog
Description

Gets the OsidSession associated with the bulk enrollment administration service for the given course catalog.

Parametersosid.id.IdcourseCatalogId the Id of the CourseCatalog
Returnosid.course.program.batch.EnrollmentBatchAdminSession an EnrollmentBatchAdminSession
ErrorsNOT_FOUND no CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEnrollmentBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsEnrollmentBatchAdmin() and supportsVisibleFederation() are true