| Interface | osid.journaling.batch.JournalingBatchManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.journaling.batch.JournalingBatchProfile | |||
| Description |
The journaling batch manager provides access to journaling batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
| Method | getJournalEntryBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.journaling.batch.JournalEntryBatchAdminSession | a JournalEntryBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsJournalEntryBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsJournalEntryBatchAdmin()
is true. | |
| Method | getJournalEntryBatchAdminSessionForJournal | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | journalId | the Id of the Journal |
| Return | osid.journaling.batch.JournalEntryBatchAdminSession | a JournalEntryBatchAdminSession | |
| Errors | NOT_FOUND | no Journal found by the given Id | |
| NULL_ARGUMENT | journalId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsJournalEntryBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsJournalEntryBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getBranchBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.journaling.batch.BranchBatchAdminSession | a BranchBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsBranchBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsBranchBatchAdmin()
is true. | |
| Method | getBranchBatchAdminSessionForJournal | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | journalId | the Id of the Journal |
| Return | osid.journaling.batch.BranchBatchAdminSession | a BranchBatchAdminSession | |
| Errors | NOT_FOUND | no Journal found by the given Id | |
| NULL_ARGUMENT | journalId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsBranchBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsBranchBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getJournalBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.journaling.batch.JournalBatchAdminSession | a JournalBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsJournalBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsJournalBatchAdmin()
is true. | |