public interface JournalingProxyManager extends OsidProxyManager, JournalingProfile
The journaling manager provides access to journaling sessions and
provides interoperability tests for various aspects of this service.
Methods in this manager accept a Proxy
for passing
information from a server environment. 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(Proxy proxy)
Gets a branch administration session for creating, updating and
deleting branches.
|
BranchAdminSession |
getBranchAdminSessionForJournal(Id journalId,
Proxy proxy)
Gets a branch administration session for the given journal.
|
BranchLookupSession |
getBranchLookupSession(Proxy proxy)
Gets the
OsidSession associated with the branch lookup
service. |
BranchLookupSession |
getBranchLookupSessionForJournal(Id journalId,
Proxy proxy)
Gets the
OsidSession associated with the branch lookup
service for the given journal. |
BranchNotificationSession |
getBranchNotificationSession(BranchReceiver branchReceiver,
Proxy proxy)
Gets the branch notification session for the given journal.
|
BranchNotificationSession |
getBranchNotificationSessionForJournal(BranchReceiver branchReceiver,
Id journalId,
Proxy proxy)
Gets the branch notification session for the given journal.
|
BranchQuerySession |
getBranchQuerySession(Proxy proxy)
Gets a branch query session.
|
BranchQuerySession |
getBranchQuerySessionForJournal(Id journalId,
Proxy proxy)
Gets a branch query session for the given journal.
|
BranchSearchSession |
getBranchSearchSession(Proxy proxy)
Gets a branch search session.
|
BranchSearchSession |
getBranchSearchSessionForJournal(Id journalId,
Proxy proxy)
Gets a branch search session for the given journal.
|
BranchSmartJournalSession |
getBranchSmartJournalSession(Id journalId,
Proxy proxy)
Gets the session for managing dynamic branch journals.
|
JournalAdminSession |
getJournalAdminSession(Proxy proxy)
Gets the
OsidSession associated with the journal
administrative service. |
JournalEntryAdminSession |
getJournalEntryAdminSession(Proxy proxy)
Gets the
OsidSession associated with the journal entry
administration service. |
JournalEntryAdminSession |
getJournalEntryAdminSessionForJournal(Id journalId,
Proxy proxy)
Gets the
OsidSession associated with the journal entry
administration service for the given journal. |
JournalEntryLookupSession |
getJournalEntryLookupSession(Proxy proxy)
Gets the
OsidSession associated with the journal entry
lookup service. |
JournalEntryLookupSession |
getJournalEntryLookupSessionForJournal(Id journalId,
Proxy proxy)
Gets the
OsidSession associated with the journal entry
lookup service for the given journal. |
JournalEntryNotificationSession |
getJournalEntryNotificationSession(JournalEntryReceiver journalEntryReceiver,
Proxy proxy)
Gets the
OsidSession associated with the journal entry
notification service. |
JournalEntryNotificationSession |
getJournalEntryNotificationSessionForJournal(JournalEntryReceiver journalEntryReceiver,
Id journalId,
Proxy proxy)
Gets the
OsidSession associated with the journal entry
notification service for the given journal. |
JournalEntryQuerySession |
getJournalEntryQuerySession(Proxy proxy)
Gets the
OsidSession associated with the journal entry
query service. |
JournalEntryQuerySession |
getJournalEntryQuerySessionForJournal(Id journalId,
Proxy proxy)
Gets the
OsidSession associated with the journal entry
query service for the given journal. |
JournalEntrySearchSession |
getJournalEntrySearchSession(Proxy proxy)
Gets the
OsidSession associated with the journal entry
search service. |
JournalEntrySearchSession |
getJournalEntrySearchSessionForJournal(Id journalId,
Proxy proxy)
Gets the
OsidSession associated with the journal entry
search service for the given journal. |
JournalHierarchyDesignSession |
getJournalHierarchyDesignSession(Proxy proxy)
Gets the
OsidSession associated with the journal
hierarchy design service. |
JournalHierarchySession |
getJournalHierarchySession(Proxy proxy)
Gets the
OsidSession associated with the journal
hierarchy service. |
JournalingBatchProxyManager |
getJournalingBatchProxyManager()
Gets a
JournalingBatchProxyManager. |
JournalLookupSession |
getJournalLookupSession(Proxy proxy)
Gets the
OsidSession associated with the journal lookup
service. |
JournalNotificationSession |
getJournalNotificationSession(JournalReceiver journalReceiver,
Proxy proxy)
Gets the
OsidSession associated with the journal
notification service. |
JournalQuerySession |
getJournalQuerySession(Proxy proxy)
Gets the
OsidSession associated with the journal query
service. |
JournalSearchSession |
getJournalSearchSession(Proxy proxy)
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the journal entry
lookup service.proxy
- a proxy JournalEntryLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntryLookup()
is false
optional
- This method must be implemented if
supportsJournalEntryLookup()
is true.
JournalEntryLookupSession getJournalEntryLookupSessionForJournal(Id journalId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the journal entry
lookup service for the given journal.journalId
- the Id
of the Journal
proxy
- a proxy JournalEntryLookupSession
NotFoundException
- no Journal
found by
the given Id
NullArgumentException
- journalId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the journal entry
query service.proxy
- a proxy JournalEntryQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntryQuery()
is false
optional
- This method must be implemented if
supportsJournalEntryQuery()
is true.
JournalEntryQuerySession getJournalEntryQuerySessionForJournal(Id journalId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the journal entry
query service for the given journal.journalId
- the Id
of the Journal
proxy
- a proxy JournalEntryQuerySession
NotFoundException
- no Journal
found by
the given Id
NullArgumentException
- journalId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the journal entry
search service.proxy
- a proxy JournalEntrySearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntrySearch()
is false
optional
- This method must be implemented if
supportsJournalEntrySearch()
is true.
JournalEntrySearchSession getJournalEntrySearchSessionForJournal(Id journalId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the journal entry
search service for the given journal.journalId
- the Id
of the Journal
proxy
- a proxy JournalEntrySearchSession
NotFoundException
- no Journal
found by
the given Id
NullArgumentException
- journalId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the journal entry
administration service.proxy
- a proxy JournalEntryAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalEntryAdmin()
is false
optional
- This method must be implemented if
supportsJournalEntryAdmin()
is true.
JournalEntryAdminSession getJournalEntryAdminSessionForJournal(Id journalId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the journal entry
administration service for the given journal.journalId
- the Id
of the Journal
proxy
- a proxy JournalEntryAdminSession
NotFoundException
- no Journal
found by
the given Id
NullArgumentException
- journalId
or
proxy
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the journal entry
notification service.journalEntryReceiver
- the receiverproxy
- a proxy JournalEntryNotificationSession
NullArgumentException
- journalEntryReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the journal entry
notification service for the given journal.journalEntryReceiver
- the receiverjournalId
- the Id
of the Journal
proxy
- a proxy JournalEntryNotificationSession
NotFoundException
- no Journal
found by
the given Id
NullArgumentException
- journalEntryReceiver,
journalId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the branch lookup
service.proxy
- a proxy a BranchLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBranchLookup()
is false
optional
- This method must be implemented if
supportsBranchLookup()
is true.
BranchLookupSession getBranchLookupSessionForJournal(Id journalId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the branch lookup
service for the given journal.journalId
- the Id
of the journalproxy
- a proxy
a BranchLookupSession
NotFoundException
- journalId
not foundNullArgumentException
- journalId
or
proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy a BranchQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBranchQuery()
is false
optional
- This method must be implemented if
supportsBranchQuery()
is true.
BranchQuerySession getBranchQuerySessionForJournal(Id journalId, Proxy proxy) throws NotFoundException, OperationFailedException
journalId
- the Id
of the journalproxy
- a proxy a BranchQuerySession
NotFoundException
- journalId
not foundNullArgumentException
- journalId
or
proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy a BranchSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBranchSearch()
is false
optional
- This method must be implemented if
supportsBranchSearch()
is true.
BranchSearchSession getBranchSearchSessionForJournal(Id journalId, Proxy proxy) throws NotFoundException, OperationFailedException
journalId
- the Id
of the journalproxy
- a proxy a BranchSearchSession
NotFoundException
- journalId
not foundNullArgumentException
- journalId
or
proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy a BranchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBranchAdmin()
is false
optional
- This method must be implemented if
supportsBranchAdmin()
is true.
BranchAdminSession getBranchAdminSessionForJournal(Id journalId, Proxy proxy) throws NotFoundException, OperationFailedException
journalId
- the Id
of the journalproxy
- a proxy a BranchAdminSession
NotFoundException
- journalId
not foundNullArgumentException
- journalId
or
proxy
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, Proxy proxy) throws OperationFailedException
branchReceiver
- notification callbackproxy
- a proxy a BranchNotificationSession
NullArgumentException
- branchReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
branchReceiver
- notification callbackjournalId
- the Id
of the journalproxy
- a proxy a BranchNotificationSession
NotFoundException
- journalId
not foundNullArgumentException
- branchReceiver,
journalId
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
journalId
- the Id
of the journalproxy
- a proxy BranchSmartJournalSession
NotFoundException
- journalId
not foundNullArgumentException
- journalId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBranchSmartJournal()
is false
optional
- This method must be implemented if
supportsBranchSmartJournal()
is true.
JournalLookupSession getJournalLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the journal lookup
service.proxy
- a proxy JournalLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsJournalLookup()
is false
optional
- This method must be implemented if
supportsJournalLookup()
is true.
JournalQuerySession getJournalQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the journal query
service.proxy
- a proxy JournalQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsJournalQuery()
is false
optional
- This method must be implemented if
supportsJournalQuery()
is true.
JournalSearchSession getJournalSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the journal search
service.proxy
- a proxy JournalSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsJournalSearch()
is false
optional
- This method must be implemented if
supportsJournalSearch()
is true.
JournalAdminSession getJournalAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the journal
administrative service.proxy
- a proxy JournalAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsJournalAdmin()
is false
optional
- This method must be implemented if
supportsJournalAdmin()
is true.
JournalNotificationSession getJournalNotificationSession(JournalReceiver journalReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the journal
notification service.journalReceiver
- the receiverproxy
- a proxy JournalNotificationSession
NullArgumentException
- journalReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalNotification()
is false
optional
- This method must be implemented if
supportsJournalNotification()
is true.
JournalHierarchySession getJournalHierarchySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the journal
hierarchy service.proxy
- a proxy JournalHierarchySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalHierarchy()
is false
optional
- This method must be implemented if
supportsJournalHierarchy()
is true.
JournalHierarchyDesignSession getJournalHierarchyDesignSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the journal
hierarchy design service.proxy
- a proxy JournalHierarchyDesignSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalHierarchyDesign()
is false
optional
- This method must be implemented if
supportsJournalHierarchyDesign()
is true.
JournalingBatchProxyManager getJournalingBatchProxyManager() throws OperationFailedException
JournalingBatchProxyManager.
JournalingBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsJournalingBatch()
is false
optional
- This method must be implemented if
supportsJournalingBatch()
is true.