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 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. |
changeBranch, initialize, rollbackService
close
supportsBranchBatchAdmin, supportsJournalBatchAdmin, supportsJournalEntryBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
JournalEntryBatchAdminSession getJournalEntryBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk journal
entry administration service. JournalEntryBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntryBatchAdmin()
is false
optional
- This method must be implemented if
supportsJournalEntryBatchAdmin()
is true.
JournalEntryBatchAdminSession getJournalEntryBatchAdminSessionForJournal(Id journalId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk journal
entry administration service for the given journal.journalId
- the Id
of the Journal
JournalEntryBatchAdminSession
NotFoundException
- no Journal
found by
the given Id
NullArgumentException
- journalId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntryBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsJournalEntryBatchAdmin()
and
supportsVisibleFederation()
are true
BranchBatchAdminSession getBranchBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk branch
administration service. BranchBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBranchBatchAdmin()
is false
optional
- This method must be implemented if
supportsBranchBatchAdmin()
is true.
BranchBatchAdminSession getBranchBatchAdminSessionForJournal(Id journalId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk branch
administration service for the given journal.journalId
- the Id
of the Journal
BranchBatchAdminSession
NotFoundException
- no Journal
found by
the given Id
NullArgumentException
- journalId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBranchBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBranchBatchAdmin()
and
supportsVisibleFederation()
are true
JournalBatchAdminSession getJournalBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk journal
administration service. JournalBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalBatchAdmin()
is false
optional
- This method must be implemented if
supportsJournalBatchAdmin()
is true.