org.osid.journaling.batch

Interface JournalingBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, JournalingBatchProfile, OsidManager, OsidProfile, Sourceable

public interface JournalingBatchManager
extends OsidManager, JournalingBatchProfile

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:

• 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

Method Summary

Methods

Modifier and Type	Method and Description
BranchBatchAdminSession	getBranchBatchAdminSession() Gets the OsidSession associated with the bulk branch administration service.
BranchBatchAdminSession	getBranchBatchAdminSessionForJournal(Id journalId) Gets the OsidSession associated with the bulk branch administration service for the given journal.
JournalBatchAdminSession	getJournalBatchAdminSession() Gets the OsidSession associated with the bulk journal administration service.
JournalEntryBatchAdminSession	getJournalEntryBatchAdminSession() Gets the OsidSession associated with the bulk journal entry administration service.
JournalEntryBatchAdminSession	getJournalEntryBatchAdminSessionForJournal(Id journalId) Gets the OsidSession associated with the bulk journal entry administration service for the given journal.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.journaling.batch.JournalingBatchProfile

supportsBranchBatchAdmin, supportsJournalBatchAdmin, supportsJournalEntryBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getJournalEntryBatchAdminSession

JournalEntryBatchAdminSession getJournalEntryBatchAdminSession()
                                                               throws OperationFailedException

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

Returns:

a JournalEntryBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalEntryBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsJournalEntryBatchAdmin() is true.

getJournalEntryBatchAdminSessionForJournal

JournalEntryBatchAdminSession getJournalEntryBatchAdminSessionForJournal(Id journalId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

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

Parameters:

journalId - the Id of the Journal

Returns:

a JournalEntryBatchAdminSession

Throws:

NotFoundException - no Journal found by the given Id

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsJournalEntryBatchAdmin() and supportsVisibleFederation() are true

getBranchBatchAdminSession

BranchBatchAdminSession getBranchBatchAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk branch administration service.

Returns:

a BranchBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsBranchBatchAdmin() is true.

getBranchBatchAdminSessionForJournal

BranchBatchAdminSession getBranchBatchAdminSessionForJournal(Id journalId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

journalId - the Id of the Journal

Returns:

a BranchBatchAdminSession

Throws:

NotFoundException - no Journal found by the given Id

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsBranchBatchAdmin() and supportsVisibleFederation() are true

getJournalBatchAdminSession

JournalBatchAdminSession getJournalBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk journal administration service.

Returns:

a JournalBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsJournalBatchAdmin() is true.