Interface JournalingBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, JournalingBatchProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface JournalingBatchProxyManager
extends OsidProxyManager, JournalingBatchProfile

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

JournalingBatchProxyManager may be accessed by multiple processing threads.

Method Summary

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

Methods inherited from interface Closeable

close

Methods inherited from interface JournalingBatchProfile

supportsBranchBatchAdmin, supportsJournalBatchAdmin, supportsJournalEntryBatchAdmin, supportsVisibleFederation

Methods inherited from interface OsidProfile

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

Methods inherited from interface OsidProxyManager

close

Methods inherited from interface OsidProxyManager

changeBranch, getProxy, getProxyCondition, initialize, rollbackService

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Details

getJournalEntryBatchAdminSession

JournalEntryBatchAdminSession getJournalEntryBatchAdminSession(Proxy proxy)
                                                        throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a JournalEntryBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalEntryBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsJournalEntryBatchAdmin()} is {@code true}.

getJournalEntryBatchAdminSessionForJournal

JournalEntryBatchAdminSession getJournalEntryBatchAdminSessionForJournal(Id journalId,
 Proxy proxy)
                                                                  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

proxy - a proxy

Returns:

a JournalEntryBatchAdminSession

Throws:

NotFoundException - no Journal found by the given Id

NullArgumentException - journalId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsJournalEntryBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getBranchBatchAdminSession

BranchBatchAdminSession getBranchBatchAdminSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the bulk branch administration service.

Parameters:

proxy - a proxy

Returns:

a BranchBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsBranchBatchAdmin()} is {@code true}.

getBranchBatchAdminSessionForJournal

BranchBatchAdminSession getBranchBatchAdminSessionForJournal(Id journalId,
 Proxy proxy)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

journalId - the Id of the Journal

proxy - a proxy

Returns:

a BranchBatchAdminSession

Throws:

NotFoundException - no Journal found by the given Id

NullArgumentException - journalId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBranchBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getJournalBatchAdminSession

JournalBatchAdminSession getJournalBatchAdminSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the bulk journal administration service.

Parameters:

proxy - a proxy

Returns:

a JournalBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsJournalBatchAdmin()} is {@code true}.