| Interface | osid.offering.batch.OfferingBatchManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.offering.batch.OfferingBatchProfile | |||
| Description | 
                 The offering batch manager provides access to offering batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: 
  | ||
| Method | getCanonicalUnitBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.offering.batch.CanonicalUnitBatchAdminSession | a  CanonicalUnitBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsCanonicalUnitBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCanonicalUnitBatchAdmin() 
 is  true.   | |
| Method | getCanonicalUnitBatchAdminSessionForCatalogue | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | catalogueId | the  Id  of the  Catalogue   | 
| Return | osid.offering.batch.CanonicalUnitBatchAdminSession | a  CanonicalUnitBatchAdminSession   | |
| Errors | NOT_FOUND | no  Catalogue  found by the given  Id   |                 |
| NULL_ARGUMENT |  catalogueId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsCanonicalUnitBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCanonicalUnitBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getOfferingBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.offering.batch.OfferingBatchAdminSession | an  OfferingBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsOfferingBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsOfferingBatchAdmin() 
 is  true.   | |
| Method | getOfferingBatchAdminSessionForCatalogue | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | catalogueId | the  Id  of the  Catalogue   | 
| Return | osid.offering.batch.OfferingBatchAdminSession | an  OfferingBatchAdminSession   | |
| Errors | NOT_FOUND | no  Catalogue  found by the given  Id   |                 |
| NULL_ARGUMENT |  catalogueId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsOfferingBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsOfferingBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getParticipantBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.offering.batch.ParticipantBatchAdminSession | a  ParticipantBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsParticipantBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsParticipantBatchAdmin() 
 is  true.   | |
| Method | getParticipantBatchAdminSessionForCatalogue | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | catalogueId | the  Id  of the  Catalogue   | 
| Return | osid.offering.batch.ParticipantBatchAdminSession | a  ParticipantBatchAdminSession   | |
| Errors | NOT_FOUND | no  Catalogue  found by the given  Id   |                 |
| NULL_ARGUMENT |  catalogueId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsParticipantBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsParticipantBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getResultBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.offering.batch.ResultBatchAdminSession | a  ResultBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsResultBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResultBatchAdmin() 
 is  true.   | |
| Method | getResultBatchAdminSessionForCatalogue | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | catalogueId | the  Id  of the  Catalogue   | 
| Return | osid.offering.batch.ResultBatchAdminSession | a  ResultBatchAdminSession   | |
| Errors | NOT_FOUND | no  Catalogue  found by the given  Id   |                 |
| NULL_ARGUMENT |  catalogueId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResultBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResultBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getCatalogueBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.offering.batch.CatalogueBatchAdminSession | a  CatalogueBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsCatalogueBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsCatalogueBatchAdmin() 
 is  true.   | |