Interface | osid.journaling.batch.JournalingBatchProxyManager | ||
---|---|---|---|
Implements | osid.OsidProxyManager | ||
osid.journaling.batch.JournalingBatchProfile | |||
Description |
The journaling batch proxy manager provides access to
journaling batch sessions and provides interoperability tests
for various aspects of this service. Methods in this manager
support the passing of a
| ||
Method | getJournalEntryBatchAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.batch.JournalEntryBatchAdminSession | a JournalEntryBatchAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
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 |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.batch.JournalEntryBatchAdminSession | a JournalEntryBatchAdminSession | |
Errors | NOT_FOUND | no Journal found by the given Id | |
NULL_ARGUMENT | journalId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.batch.BranchBatchAdminSession | a BranchBatchAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
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 |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.batch.BranchBatchAdminSession | a BranchBatchAdminSession | |
Errors | NOT_FOUND | no Journal found by the given Id | |
NULL_ARGUMENT | journalId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.batch.JournalBatchAdminSession | a JournalBatchAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsJournalBatchAdmin()
is true. |