| Interface | osid.hold.batch.HoldBatchManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.hold.batch.HoldBatchProfile | |||
| Description | 
                 The hold batch manager provides access to hold batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: 
  | ||
| Method | getBlockBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.hold.batch.BlockBatchAdminSession | a  BlockBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsBlockBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBlockBatchAdmin()  
is  true.   | |
| Method | getBlockBatchAdminSessionForOubliette | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | oublietteId | the  Id  of the  Oubliette   | 
| Return | osid.hold.batch.BlockBatchAdminSession | a  BlockBatchAdminSession   | |
| Errors | NOT_FOUND | no  Oubliette  found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsBlockBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBlockBatchAdmin()  
and  supportsVisibleFederation()  are  true   | |
| Method | getIssueBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.hold.batch.IssueBatchAdminSession | an  IssueBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsIssueBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsIssueBatchAdmin()  
is  true.   | |
| Method | getIssueBatchAdminSessionForOubliette | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | oublietteId | the  Id  of the  Oubliette   | 
| Return | osid.hold.batch.IssueBatchAdminSession | an  IssueBatchAdminSession   | |
| Errors | NOT_FOUND | no  Oubliette  found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsIssueBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsIssueBatchAdmin()  
and  supportsVisibleFederation()  are  true   | |
| Method | getHoldBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.hold.batch.HoldBatchAdminSession | a  HoldBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsHoldBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsHoldBatchAdmin()  
is  true.   | |
| Method | getHoldBatchAdminSessionForOubliette | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | oublietteId | the  Id  of the  Oubliette   | 
| Return | osid.hold.batch.HoldBatchAdminSession | a  HoldBatchAdminSession   | |
| Errors | NOT_FOUND | no  Oubliette  found by the given  Id   |                 |
| NULL_ARGUMENT |  oublietteId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsHoldBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsHoldBatchAdmin()  
and  supportsVisibleFederation()  are  true   | |
| Method | getOublietteBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Return | osid.hold.batch.OublietteBatchAdminSession | a  OublietteBatchAdminSession   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsOublietteBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsOublietteBatchAdmin() 
 is  true.   | |