OSID Logo
OSID Specifications
course program batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.batch.CourseProgramBatchProxyManager
Implementsosid.OsidProxyManager
osid.course.program.batch.CourseProgramBatchProfile
Description

The course program batch proxy manager provides access to course program batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. 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 credentials 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.program.batch.ProgramBatchAdminSessiona ProgramBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramBatchAdmin() is false
ComplianceoptionalThis 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.IdcourseCatalogIdthe Id of the CourseCatalog
osid.proxy.Proxyproxya proxy
Returnosid.course.program.batch.ProgramBatchAdminSessiona ProgramBatchAdminSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProgramBatchAdmin() and supportsVisibleFederation() are true
MethodgetProgramOfferingBatchAdminSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.program.batch.ProgramOfferingBatchAdminSessiona ProgramOfferingBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramOfferingBatchAdmin() is false
ComplianceoptionalThis 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.IdcourseCatalogIdthe Id of the CourseCatalog
osid.proxy.Proxyproxya proxy
Returnosid.course.program.batch.ProgramOfferingBatchAdminSessiona ProgramOfferingBatchAdminSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProgramOfferingBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingBatchAdmin() and supportsVisibleFederation() are true
MethodgetCredentialBatchAdminSession
Description

Gets the OsidSession associated with the bulk credential administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.program.batch.CredentialBatchAdminSessiona CredentialBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCredentialBatchAdmin() is false
ComplianceoptionalThis 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.IdcourseCatalogIdthe Id of the CourseCatalog
osid.proxy.Proxyproxya proxy
Returnosid.course.program.batch.CredentialBatchAdminSessiona CredentialBatchAdminSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCredentialBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCredentialBatchAdmin() and supportsVisibleFederation() are true
MethodgetEnrollmentBatchAdminSession
Description

Gets the OsidSession associated with the bulk enrollment administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.program.batch.EnrollmentBatchAdminSessionan EnrollmentBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEnrollmentBatchAdmin() is false
ComplianceoptionalThis 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.IdcourseCatalogIdthe Id of the CourseCatalog
osid.proxy.Proxyproxya proxy
Returnosid.course.program.batch.EnrollmentBatchAdminSessionan EnrollmentBatchAdminSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEnrollmentBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEnrollmentBatchAdmin() and supportsVisibleFederation() are true