Interface JournalingBatchManager

All Superinterfaces:

AutoCloseable, Closeable, JournalingBatchProfile, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface JournalingBatchProfile

supportsBranchBatchAdmin, supportsJournalBatchAdmin, supportsJournalEntryBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsBranchBatchAdmin()	Tests if bulk administration of branches is available.
boolean	supportsJournalBatchAdmin()	Tests if bulk administration of journals is available.
boolean	supportsJournalEntryBatchAdmin()	Tests if bulk administration of journal entries is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsJournalEntryBatchAdmin()} is {@code 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 {@code supportsJournalEntryBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsBranchBatchAdmin()} is {@code 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 {@code supportsBranchBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsJournalBatchAdmin()} is {@code true} .