public interface JournalingManager extends OsidManager, JournalingProfile
The journaling manager provides access to journaling sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
JournalEntryLookupSession:
a session to lookup
journal entries JournalEntryQuerySession:
a session to query
journal entries JournalEntrySearchSession:
a session to search
journal entries JournalEntryAdminSession:
a session to manage
journal entries JournalEntryNotificationSession:
a session to
subscribe to notifications of journal entry changes BranchLookupSession:
a session to retrieve
branches BranchQuerySession:
a session to query branches
BranchSearchSession:
a session to search for
branches BranchAdminSession:
a session to create and delete
brancehs BranchNotificationSession:
a session to receive
notifications pertaining to branch changes BranchSmartJournalSession:
a session to manage
smart branch journals JournalLookupSession:
a session to retrieve
journals JournalQuerySession
: a session to query journals
JournalSearchSession:
a session to search for
journals JournalAdminSession:
a session to create, update
and delete journals JournalNotificationSession:
a session to receive
notifications for changes in journals JournalHierarchyTraversalSession:
a session to
traverse hierarchies of journals JournalHierarchyDesignSession:
a session to manage
hierarchies of journals The journaling manager also provides a profile for determing the supported search types supported by this service.
Modifier and Type | Method and Description |
---|---|
BranchAdminSession |
getBranchAdminSession()
Gets a branch administration session for creating, updating and
deleting branches.
|
BranchAdminSession |
getBranchAdminSessionForJournal(Id journalId)
Gets a branch administration session for the given journal.
|
BranchLookupSession |
getBranchLookupSession()
Gets the
OsidSession associated with the branch lookup
service. |
BranchLookupSession |
getBranchLookupSessionForJournal(Id journalId)
Gets the
OsidSession associated with the branch lookup
service for the given journal. |
BranchNotificationSession |
getBranchNotificationSession(BranchReceiver branchReceiver)
Gets the notification session for notifications pertaining to branch
changes.
|
BranchNotificationSession |
getBranchNotificationSessionForJournal(BranchReceiver branchReceiver,
Id journalId)
Gets the branch notification session for the given journal.
|
BranchQuerySession |
getBranchQuerySession()
Gets a branch query session.
|
BranchQuerySession |
getBranchQuerySessionForJournal(Id journalId)
Gets a branch query session for the given journal.
|
BranchSearchSession |
getBranchSearchSession()
Gets a branch search session.
|
BranchSearchSession |
getBranchSearchSessionForJournal(Id journalId)
Gets a branch search session for the given journal.
|
BranchSmartJournalSession |
getBranchSmartJournalSession(Id journalId)
Gets the session for managing dynamic branch journals.
|
JournalAdminSession |
getJournalAdminSession()
Gets the
OsidSession associated with the journal
administrative service. |
JournalEntryAdminSession |
getJournalEntryAdminSession()
Gets the
OsidSession associated with the journal entry
administration service. |
JournalEntryAdminSession |
getJournalEntryAdminSessionForJournal(Id journalId)
Gets the
OsidSession associated with the journal entry
administration service for the given journal. |
JournalEntryLookupSession |
getJournalEntryLookupSession()
Gets the
OsidSession associated with the journal entry
lookup service. |
JournalEntryLookupSession |
getJournalEntryLookupSessionForJournal(Id journalId)
Gets the
OsidSession associated with the journal entry
lookup service for the given journal. |
JournalEntryNotificationSession |
getJournalEntryNotificationSession(JournalEntryReceiver journalEntryReceiver)
Gets the
OsidSession associated with the journal entry
notification service. |
JournalEntryNotificationSession |
getJournalEntryNotificationSessionForJournal(JournalEntryReceiver journalEntryReceiver,
Id journalId)
Gets the
OsidSession associated with the journal entry
notification service for the given journal. |
JournalEntryQuerySession |
getJournalEntryQuerySession()
Gets the
OsidSession associated with the journal entry
query service. |
JournalEntryQuerySession |
getJournalEntryQuerySessionForJournal(Id journalId)
Gets the
OsidSession associated with the journal entry
query service for the given journal. |
JournalEntrySearchSession |
getJournalEntrySearchSession()
Gets the
OsidSession associated with the journal entry
search service. |
JournalEntrySearchSession |
getJournalEntrySearchSessionForJournal(Id journalId)
Gets the
OsidSession associated with the journal entry
search service for the given journal. |
JournalHierarchyDesignSession |
getJournalHierarchyDesignSession()
Gets the
OsidSession associated with the journal
hierarchy design service. |
JournalHierarchySession |
getJournalHierarchySession()
Gets the
OsidSession associated with the journal
hierarchy service. |
JournalingBatchManager |
getJournalingBatchManager()
Gets a
JournalingBatchManager. |
JournalLookupSession |
getJournalLookupSession()
Gets the
OsidSession associated with the journal lookup
service. |
JournalNotificationSession |
getJournalNotificationSession(JournalReceiver journalReceiver)
Gets the
OsidSession associated with the journal
notification service. |
JournalQuerySession |
getJournalQuerySession()
Gets the
OsidSession associated with the journal query
service. |
JournalSearchSession |
getJournalSearchSession()
Gets the
OsidSession associated with the journal search
service. |
changeBranch, initialize, rollbackService
close
getBranchRecordTypes, getBranchSearchRecordTypes, getJournalEntryRecordTypes, getJournalEntrySearchRecordTypes, getJournalRecordTypes, getJournalSearchRecordTypes, supportsBranchAdmin, supportsBranchLookup, supportsBranchNotification, supportsBranchQuery, supportsBranchRecordType, supportsBranchSearch, supportsBranchSearchRecordType, supportsBranchSmartJournal, supportsJournalAdmin, supportsJournalEntryAdmin, supportsJournalEntryLookup, supportsJournalEntryNotification, supportsJournalEntryQuery, supportsJournalEntryRecordType, supportsJournalEntrySearch, supportsJournalEntrySearchRecordType, supportsJournalHierarchy, supportsJournalHierarchyDesign, supportsJournalLookup, supportsJournalngBatch, supportsJournalNotification, supportsJournalQuery, supportsJournalRecordType, supportsJournalSearch, supportsJournalSearchRecordType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
JournalEntryLookupSession getJournalEntryLookupSession() throws OperationFailedException
OsidSession
associated with the journal entry
lookup service. JournalEntryLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntryLookup()
is false
optional
- This method must be implemented if
supportsJournalEntryLookup()
is true.
JournalEntryLookupSession getJournalEntryLookupSessionForJournal(Id journalId) throws NotFoundException, OperationFailedException
OsidSession
associated with the journal entry
lookup service for the given journal.journalId
- the Id
of the Journal
JournalEntryLookupSession
NotFoundException
- no Journal
found by
the given Id
NullArgumentException
- journalId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntryLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsJournalEntryLookup()
and
supportsVisibleFederation()
are true
JournalEntryQuerySession getJournalEntryQuerySession() throws OperationFailedException
OsidSession
associated with the journal entry
query service. JournalEntryQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntryQuery()
is false
optional
- This method must be implemented if
supportsJournalEntryQuery()
is true.
JournalEntryQuerySession getJournalEntryQuerySessionForJournal(Id journalId) throws NotFoundException, OperationFailedException
OsidSession
associated with the journal entry
query service for the given journal.journalId
- the Id
of the Journal
JournalEntryQuerySession
NotFoundException
- no Journal
found by
the given Id
NullArgumentException
- journalId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntryQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsJournalEntryQuery()
and
supportsVisibleFederation()
are true
JournalEntrySearchSession getJournalEntrySearchSession() throws OperationFailedException
OsidSession
associated with the journal entry
search service. JournalEntrySearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntrySearch()
is false
optional
- This method must be implemented if
supportsJournalEntrySearch()
is true.
JournalEntrySearchSession getJournalEntrySearchSessionForJournal(Id journalId) throws NotFoundException, OperationFailedException
OsidSession
associated with the journal entry
search service for the given journal.journalId
- the Id
of the Journal
JournalEntrySearchSession
NotFoundException
- no Journal
found by
the given Id
NullArgumentException
- journalId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntrySearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsJournalEntrySearch()
and
supportsVisibleFederation()
are true
JournalEntryAdminSession getJournalEntryAdminSession() throws OperationFailedException
OsidSession
associated with the journal entry
administration service. JournalEntryAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntryAdmin()
is false
optional
- This method must be implemented if
supportsJournalEntryAdmin()
is true.
JournalEntryAdminSession getJournalEntryAdminSessionForJournal(Id journalId) throws NotFoundException, OperationFailedException
OsidSession
associated with the journal entry
administration service for the given journal.journalId
- the Id
of the Journal
JournalEntryAdminSession
NotFoundException
- no Journal
found by
the given Id
NullArgumentException
- journalId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntryAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsJournalEntryAdmin()
and
supportsVisibleFederation()
are true
JournalEntryNotificationSession getJournalEntryNotificationSession(JournalEntryReceiver journalEntryReceiver) throws OperationFailedException
OsidSession
associated with the journal entry
notification service.journalEntryReceiver
- the receiver JournalEntryNotificationSession
NullArgumentException
- journalEntryReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntryNotification()
is false
optional
- This method must be implemented if
supportsJournalEntryNotification()
is true.
JournalEntryNotificationSession getJournalEntryNotificationSessionForJournal(JournalEntryReceiver journalEntryReceiver, Id journalId) throws NotFoundException, OperationFailedException
OsidSession
associated with the journal entry
notification service for the given journal.journalEntryReceiver
- the receiverjournalId
- the Id
of the Journal
JournalEntryNotificationSession
NotFoundException
- no Journal
found by
the given Id
NullArgumentException
- journalEntryReceiver
or journalId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntryNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsJournalEntryNotification()
and
supportsVisibleFederation()
are true
BranchLookupSession getBranchLookupSession() throws OperationFailedException
OsidSession
associated with the branch lookup
service. a BranchLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBranchLookup()
is false
optional
- This method must be implemented if
supportsBranchLookup()
is true.
BranchLookupSession getBranchLookupSessionForJournal(Id journalId) throws NotFoundException, OperationFailedException
OsidSession
associated with the branch lookup
service for the given journal.journalId
- the Id
of the journal a BranchLookupSession
NotFoundException
- journalId
not foundNullArgumentException
- journalId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsBranchLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBranchLookup()
and
supportsVisibleFederation()
are true.
BranchQuerySession getBranchQuerySession() throws OperationFailedException
a BranchQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBranchQuery()
is false
optional
- This method must be implemented if
supportsBranchQuery()
is true.
BranchQuerySession getBranchQuerySessionForJournal(Id journalId) throws NotFoundException, OperationFailedException
journalId
- the Id
of the journal a BranchQuerySession
NotFoundException
- journalId
not foundNullArgumentException
- journalId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsBranchQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBranchQuery()
and
supportsVisibleFederation()
are true.
BranchSearchSession getBranchSearchSession() throws OperationFailedException
a BranchSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBranchSearch()
is false
optional
- This method must be implemented if
supportsBranchSearch()
is true.
BranchSearchSession getBranchSearchSessionForJournal(Id journalId) throws NotFoundException, OperationFailedException
journalId
- the Id
of the journal a BranchSearchSession
NotFoundException
- journalId
not foundNullArgumentException
- journalId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsBranchSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBranchSearch()
and
supportsVisibleFederation()
are true.
BranchAdminSession getBranchAdminSession() throws OperationFailedException
a BranchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBranchAdmin()
is false
optional
- This method must be implemented if
supportsBranchAdmin()
is true.
BranchAdminSession getBranchAdminSessionForJournal(Id journalId) throws NotFoundException, OperationFailedException
journalId
- the Id
of the journal a BranchAdminSession
NotFoundException
- journalId
not foundNullArgumentException
- journalId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBranchAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBranchAdmin()
and
supportsVisibleFederation()
are true.
BranchNotificationSession getBranchNotificationSession(BranchReceiver branchReceiver) throws OperationFailedException
branchReceiver
- the notification callback a BranchNotificationSession
NullArgumentException
- branchReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBranchNotification()
is false
optional
- This method must be implemented if
supportsBranchNotification()
is true.
BranchNotificationSession getBranchNotificationSessionForJournal(BranchReceiver branchReceiver, Id journalId) throws NotFoundException, OperationFailedException
branchReceiver
- the notification callbackjournalId
- the Id
of the journal a BranchNotificationSession
NotFoundException
- journalId
not foundNullArgumentException
- branchReceiver
or journalId
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsBranchNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBranchNotfication()
and
supportsVisibleFederation()
are true.
BranchSmartJournalSession getBranchSmartJournalSession(Id journalId) throws NotFoundException, OperationFailedException
journalId
- the Id
of the journal BranchSmartJournalSession
NotFoundException
- journalId
not foundNullArgumentException
- journalId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBranchSmartJournal()
is false
optional
- This method must be implemented if
supportsBranchSmartJournal()
is true.
JournalLookupSession getJournalLookupSession() throws OperationFailedException
OsidSession
associated with the journal lookup
service. JournalLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsJournalLookup()
is false
optional
- This method must be implemented if
supportsJournalLookup()
is true.
JournalQuerySession getJournalQuerySession() throws OperationFailedException
OsidSession
associated with the journal query
service. JournalQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsJournalQuery()
is false
optional
- This method must be implemented if
supportsJournalQuery()
is true.
JournalSearchSession getJournalSearchSession() throws OperationFailedException
OsidSession
associated with the journal search
service. JournalSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsJournalSearch()
is false
optional
- This method must be implemented if
supportsJournalSearch()
is true.
JournalAdminSession getJournalAdminSession() throws OperationFailedException
OsidSession
associated with the journal
administrative service. JournalAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsJournalAdmin()
is false
optional
- This method must be implemented if
supportsJournalAdmin()
is true.
JournalNotificationSession getJournalNotificationSession(JournalReceiver journalReceiver) throws OperationFailedException
OsidSession
associated with the journal
notification service.journalReceiver
- the receiver JournalNotificationSession
NullArgumentException
- journalReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalNotification()
is false
optional
- This method must be implemented if
supportsJournalNotification()
is true.
JournalHierarchySession getJournalHierarchySession() throws OperationFailedException
OsidSession
associated with the journal
hierarchy service. JournalHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalHierarchy()
is false
optional
- This method must be implemented if
supportsJournalHierarchy()
is true.
JournalHierarchyDesignSession getJournalHierarchyDesignSession() throws OperationFailedException
OsidSession
associated with the journal
hierarchy design service. JournalHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalHierarchyDesign()
is false
optional
- This method must be implemented if
supportsJournalHierarchyDesign()
is true.
JournalingBatchManager getJournalingBatchManager() throws OperationFailedException
JournalingBatchManager.
JournalingBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalingBatch()
is false
optional
- This method must be implemented if
supportsJournalingBatch()
is true.