| Interface | osid.course.batch.CourseBatchManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
| osid.course.batch.CourseBatchProfile | |||
| Description | The course batch manager provides access to course batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: 
 | ||
| Method | getCourseBatchAdminSession | ||
| Description | Gets the  | ||
| Return | osid.course.batch.CourseBatchAdminSession | a  CourseBatchAdminSession  | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsCourseBatchAdmin() is false  | ||
| Compliance | optional | This method must be implemented if  supportsCourseBatchAdmin() 
is true.  | |
| Method | getCourseBatchAdminSessionForCourseCatalog | ||
| Description | Gets the  | ||
| Parameters | osid.id.Id | courseCatalogId | the  Id of the CourseCatalog  | 
| Return | osid.course.batch.CourseBatchAdminSession | a  CourseBatchAdminSession  | |
| Errors | NOT_FOUND | no  CourseCatalog found by the given Id  | |
| NULL_ARGUMENT |  courseCatalogId is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsCourseBatchAdmin() or 
supportsVisibleFederation() is false  | ||
| Compliance | optional | This method must be implemented if  supportsCourseBatchAdmin() 
and supportsVisibleFederation() are true  | |
| Method | getActivityUnitBatchAdminSession | ||
| Description | Gets the  | ||
| Return | osid.course.batch.ActivityUnitBatchAdminSession | an  ActivityUnitBatchAdminSession  | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsActivityUnitBatchAdmin() is false  | ||
| Compliance | optional | This method must be implemented if  supportsActivityUnitBatchAdmin() 
is true.  | |
| Method | getActivityUnitBatchAdminSessionForCourseCatalog | ||
| Description | Gets the  | ||
| Parameters | osid.id.Id | courseCatalogId | the  Id of the CourseCatalog  | 
| Return | osid.course.batch.ActivityUnitBatchAdminSession | an  ActivityUnitBatchAdminSession  | |
| Errors | NOT_FOUND | no  CourseCatalog found by the given Id  | |
| NULL_ARGUMENT |  courseCatalogId is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsActivityUnitBatchAdmin() or 
supportsVisibleFederation() is false  | ||
| Compliance | optional | This method must be implemented if  supportsActivityUnitBatchAdmin() 
and supportsVisibleFederation() are true  | |
| Method | getCourseOfferingBatchAdminSession | ||
| Description | Gets the  | ||
| Return | osid.course.batch.CourseOfferingBatchAdminSession | a  CourseOfferingBatchAdminSession  | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsCourseOfferingBatchAdmin() is false  | ||
| Compliance | optional | This method must be implemented if  
supportsCourseOfferingBatchAdmin() is true.  | |
| Method | getCourseOfferingBatchAdminSessionForCourseCatalog | ||
| Description | Gets the  | ||
| Parameters | osid.id.Id | courseCatalogId | the  Id of the CourseCatalog  | 
| Return | osid.course.batch.CourseOfferingBatchAdminSession | a  CourseOfferingBatchAdminSession  | |
| Errors | NOT_FOUND | no  CourseCatalog found by the given Id  | |
| NULL_ARGUMENT |  courseCatalogId is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsCourseOfferingBatchAdmin() or 
supportsVisibleFederation() is false  | ||
| Compliance | optional | This method must be implemented if  
supportsCourseOfferingBatchAdmin() and 
supportsVisibleFederation() are true  | |
| Method | getActivityBatchAdminSession | ||
| Description | Gets the  | ||
| Return | osid.course.batch.ActivityBatchAdminSession | an  ActivityBatchAdminSession  | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsActivityBatchAdmin() is false  | ||
| Compliance | optional | This method must be implemented if  supportsActivityBatchAdmin() 
is true.  | |
| Method | getActivityBatchAdminSessionForCourseCatalog | ||
| Description | Gets the  | ||
| Parameters | osid.id.Id | courseCatalogId | the  Id of the CourseCatalog  | 
| Return | osid.course.batch.ActivityBatchAdminSession | an  ActivityBatchAdminSession  | |
| Errors | NOT_FOUND | no  CourseCatalog found by the given Id  | |
| NULL_ARGUMENT |  courseCatalogId is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsActivityBatchAdmin() or 
supportsVisibleFederation() is false  | ||
| Compliance | optional | This method must be implemented if  supportsActivityBatchAdmin() 
and supportsVisibleFederation() are true  | |
| Method | getTermBatchAdminSession | ||
| Description | Gets the  | ||
| Return | osid.course.batch.TermBatchAdminSession | a  TermBatchAdminSession  | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsTermBatchAdmin() is false  | ||
| Compliance | optional | This method must be implemented if  supportsTermBatchAdmin() is true.  | |
| Method | getTermBatchAdminSessionForCourseCatalog | ||
| Description | Gets the  | ||
| Parameters | osid.id.Id | courseCatalogId | the  Id of the CourseCatalog  | 
| Return | osid.course.batch.TermBatchAdminSession | a  TermBatchAdminSession  | |
| Errors | NOT_FOUND | no  CourseCatalog found by the given Id  | |
| NULL_ARGUMENT |  courseCatalogId is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsTermBatchAdmin() or 
supportsVisibleFederation() is false  | ||
| Compliance | optional | This method must be implemented if  supportsTermBatchAdmin() and supportsVisibleFederation() are true  | |
| Method | getCourseCatalogBatchAdminSession | ||
| Description | Gets the  | ||
| Return | osid.course.batch.CourseCatalogBatchAdminSession | a  CourseCatalogBatchAdminSession  | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsCourseCatalogBatchAdmin() is false  | ||
| Compliance | optional | This method must be implemented if  supportsCourseCatalogBatchAdmin() 
is true.  | |