OSID Logo
OSID Specifications
journaling batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.batch.JournalingBatchProxyManager
Implementsosid.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 Proxy object. The sessions included in this manager are:

  • JournalEntryBatchAdminSession: a session to create, modify and delete journal entries in bulk
  • BranchBatchSession: a session to create, modify and delete branches in bulk
  • JournalBatchAdminSession: a session to create, modify and delete journals in bulk
MethodgetJournalEntryBatchAdminSession
Description

Gets the OsidSession associated with the bulk journal entry administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.batch.JournalEntryBatchAdminSessiona JournalEntryBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalEntryBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsJournalEntryBatchAdmin() is true.
MethodgetJournalEntryBatchAdminSessionForJournal
Description

Gets the OsidSession associated with the bulk journal entry administration service for the given journal.

Parametersosid.id.IdjournalIdthe Id of the Journal
osid.proxy.Proxyproxya proxy
Returnosid.journaling.batch.JournalEntryBatchAdminSessiona JournalEntryBatchAdminSession
ErrorsNOT_FOUNDno Journal found by the given Id
NULL_ARGUMENT journalId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalEntryBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsJournalEntryBatchAdmin() and supportsVisibleFederation() are true
MethodgetBranchBatchAdminSession
Description

Gets the OsidSession associated with the bulk branch administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.batch.BranchBatchAdminSessiona BranchBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBranchBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBranchBatchAdmin() is true.
MethodgetBranchBatchAdminSessionForJournal
Description

Gets the OsidSession associated with the bulk branch administration service for the given journal.

Parametersosid.id.IdjournalIdthe Id of the Journal
osid.proxy.Proxyproxya proxy
Returnosid.journaling.batch.BranchBatchAdminSessiona BranchBatchAdminSession
ErrorsNOT_FOUNDno Journal found by the given Id
NULL_ARGUMENT journalId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBranchBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBranchBatchAdmin() and supportsVisibleFederation() are true
MethodgetJournalBatchAdminSession
Description

Gets the OsidSession associated with the bulk journal administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.batch.JournalBatchAdminSessiona JournalBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsJournalBatchAdmin() is true.