| Interface | osid.course.program.batch.CourseProgramBatchManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.course.program.batch.CourseProgramBatchProfile | |||
| 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: 
  | ||
| Method | getProgramBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.course.program.batch.ProgramBatchAdminSession | a  ProgramBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsProgramBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsProgramBatchAdmin() 
 is  true.   | |
| Method | getProgramBatchAdminSessionForCourseCatalog | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | courseCatalogId | the  Id  of the  CourseCatalog   | 
| Return | osid.course.program.batch.ProgramBatchAdminSession | a  ProgramBatchAdminSession   | |
| Errors | NOT_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   |                 ||
| Compliance | optional | This method must be implemented if  supportsProgramBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getProgramOfferingBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.course.program.batch.ProgramOfferingBatchAdminSession | a  ProgramOfferingBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsProgramOfferingBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  
supportsProgramOfferingBatchAdmin()  is  true.   | |
| Method | getProgramOfferingBatchAdminSessionForCourseCatalog | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | courseCatalogId | the  Id  of the  CourseCatalog   | 
| Return | osid.course.program.batch.ProgramOfferingBatchAdminSession | a  ProgramOfferingBatchAdminSession   | |
| Errors | NOT_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   |                 ||
| Compliance | optional | This method must be implemented if  
supportsProgramOfferingBatchAdmin()  and  
supportsVisibleFederation()  are  true   | |
| Method | getCredentialBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.course.program.batch.CredentialBatchAdminSession | a  CredentialBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsCredentialBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCredentialBatchAdmin() 
 is  true.   | |
| Method | getCredentialBatchAdminSessionForCourseCatalog | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | courseCatalogId | the  Id  of the  CourseCatalog   | 
| Return | osid.course.program.batch.CredentialBatchAdminSession | a  CredentialBatchAdminSession   | |
| Errors | NOT_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   |                 ||
| Compliance | optional | This method must be implemented if  supportsCredentialBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getEnrollmentBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.course.program.batch.EnrollmentBatchAdminSession | an  EnrollmentBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsEnrollmentBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsEnrollmentBatchAdmin() 
 is  true.   | |
| Method | getEnrollmentBatchAdminSessionForCourseCatalog | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | courseCatalogId | the  Id  of the  CourseCatalog   | 
| Return | osid.course.program.batch.EnrollmentBatchAdminSession | an  EnrollmentBatchAdminSession   | |
| Errors | NOT_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   |                 ||
| Compliance | optional | This method must be implemented if  supportsEnrollmentBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |