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 Modifier and Type | Method and 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. |
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk journal
entry administration service.proxy
- a proxy JournalEntryBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntryBatchAdmin()
is false
optional
- This method must be implemented if
supportsJournalEntryBatchAdmin()
is true.
JournalEntryBatchAdminSession getJournalEntryBatchAdminSessionForJournal(Id journalId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk journal
entry administration service for the given journal.journalId
- the Id
of the Journal
proxy
- a proxy JournalEntryBatchAdminSession
NotFoundException
- no Journal
found by
the given Id
NullArgumentException
- journalId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk branch
administration service.proxy
- a proxy BranchBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBranchBatchAdmin()
is false
optional
- This method must be implemented if
supportsBranchBatchAdmin()
is true.
BranchBatchAdminSession getBranchBatchAdminSessionForJournal(Id journalId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk branch
administration service for the given journal.journalId
- the Id
of the Journal
proxy
- a proxy BranchBatchAdminSession
NotFoundException
- no Journal
found by
the given Id
NullArgumentException
- journalId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk journal
administration service.proxy
- a proxy JournalBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalBatchAdmin()
is false
optional
- This method must be implemented if
supportsJournalBatchAdmin()
is true.