Interface JournalingManager
- All Superinterfaces:
AutoCloseable, Closeable, JournalingProfile, OsidManager, OsidManager, OsidProfile, Sourceable
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.
-
Method Summary
Modifier and TypeMethodDescriptionGets a branch administration session for creating, updating and deleting branches.getBranchAdminSessionForJournal(Id journalId) Gets a branch administration session for the given journal.Gets theOsidSessionassociated with the branch lookup service.getBranchLookupSessionForJournal(Id journalId) Gets theOsidSessionassociated with the branch lookup service for the given journal.getBranchNotificationSession(BranchReceiver branchReceiver) Gets the notification session for notifications pertaining to branch changes.getBranchNotificationSessionForJournal(BranchReceiver branchReceiver, Id journalId) Gets the branch notification session for the given journal.Gets a branch query session.getBranchQuerySessionForJournal(Id journalId) Gets a branch query session for the given journal.Gets a branch search session.getBranchSearchSessionForJournal(Id journalId) Gets a branch search session for the given journal.getBranchSmartJournalSession(Id journalId) Gets the session for managing dynamic branch journals.Gets theOsidSessionassociated with the journal administrative service.Gets theOsidSessionassociated with the journal entry administration service.getJournalEntryAdminSessionForJournal(Id journalId) Gets theOsidSessionassociated with the journal entry administration service for the given journal.Gets theOsidSessionassociated with the journal entry lookup service.getJournalEntryLookupSessionForJournal(Id journalId) Gets theOsidSessionassociated with the journal entry lookup service for the given journal.getJournalEntryNotificationSession(JournalEntryReceiver journalEntryReceiver) Gets theOsidSessionassociated with the journal entry notification service.getJournalEntryNotificationSessionForJournal(JournalEntryReceiver journalEntryReceiver, Id journalId) Gets theOsidSessionassociated with the journal entry notification service for the given journal.Gets theOsidSessionassociated with the journal entry query service.getJournalEntryQuerySessionForJournal(Id journalId) Gets theOsidSessionassociated with the journal entry query service for the given journal.Gets theOsidSessionassociated with the journal entry search service.getJournalEntrySearchSessionForJournal(Id journalId) Gets theOsidSessionassociated with the journal entry search service for the given journal.Gets theOsidSessionassociated with the journal hierarchy design service.Gets theOsidSessionassociated with the journal hierarchy service.Gets aJournalingBatchManager.Gets theOsidSessionassociated with the journal lookup service.getJournalNotificationSession(JournalReceiver journalReceiver) Gets theOsidSessionassociated with the journal notification service.Gets theOsidSessionassociated with the journal query service.Gets theOsidSessionassociated with the journal search service.Methods inherited from interface JournalingProfile
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, supportsVisibleFederationModifier and TypeMethodDescriptionGets all the branch record types supported.Gets all the branch search record types supported.Gets the supportedJournalEntryrecord types.Gets the supported journal entry search record types.Gets the supportedJournalrecord types.Gets the supported journal search record types.booleanTests if branch administration is supported.booleanTests if branch lookup is supported.booleanTests if branch notification is supported.booleanTests if branch query is supported.booleansupportsBranchRecordType(Type branchRecordType) Tests if a given branch record type is supported.booleanTests if branch search is supported.booleansupportsBranchSearchRecordType(Type branchSearchRecordType) Tests if a given branch search type is supported.booleanTests if branch smart journals are available.booleanTests for the availability of a journal administrative service for creating and deleting journals.booleanTests if searching for journal entries is available.booleanTests for the availability of a journal entry lookup service.booleanTests if journal entry notification is available.booleanTests if querying journal entries is available.booleansupportsJournalEntryRecordType(Type journalEntryRecordType) Tests if the givenJournalEntryrecord type is supported.booleanTests if searching for journal entries is available.booleansupportsJournalEntrySearchRecordType(Type journalEntrySearchRecordType) Tests if the given journal entry search record type is supported.booleanTests for the availability of a journal hierarchy traversal service.booleanTests for the availability of a journal hierarchy design service.booleanTests for the availability of a journal lookup service.booleanTests for the availability of a journaling batch service.booleanTests for the availability of a journal notification service.booleanTests if querying journals is available.booleansupportsJournalRecordType(Type journalRecordType) Tests if the givenJournalrecord type is supported.booleanTests if searching for journals is available.booleansupportsJournalSearchRecordType(Type journalSearchRecordType) Tests if the given journal search record type is supported.booleanTests if any journal federation is exposed.Methods inherited from interface OsidManager
closeMethods inherited from interface OsidManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.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, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getJournalEntryLookupSession
Gets theOsidSessionassociated with the journal entry lookup service.- Returns:
- a
JournalEntryLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJournalEntryLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalEntryLookup()} is {@code true} .
-
getJournalEntryLookupSessionForJournal
JournalEntryLookupSession getJournalEntryLookupSessionForJournal(Id journalId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the journal entry lookup service for the given journal.- Parameters:
journalId- theIdof theJournal- Returns:
- a
JournalEntryLookupSession - Throws:
NotFoundException- noJournalfound by the givenIdNullArgumentException-journalIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsJournalEntryLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalEntryLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getJournalEntryQuerySession
Gets theOsidSessionassociated with the journal entry query service.- Returns:
- a
JournalEntryQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJournalEntryQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalEntryQuery()} is {@code true} .
-
getJournalEntryQuerySessionForJournal
JournalEntryQuerySession getJournalEntryQuerySessionForJournal(Id journalId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the journal entry query service for the given journal.- Parameters:
journalId- theIdof theJournal- Returns:
- a
JournalEntryQuerySession - Throws:
NotFoundException- noJournalfound by the givenIdNullArgumentException-journalIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsJournalEntryQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalEntryQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getJournalEntrySearchSession
Gets theOsidSessionassociated with the journal entry search service.- Returns:
- a
JournalEntrySearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJournalEntrySearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalEntrySearch()} is {@code true} .
-
getJournalEntrySearchSessionForJournal
JournalEntrySearchSession getJournalEntrySearchSessionForJournal(Id journalId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the journal entry search service for the given journal.- Parameters:
journalId- theIdof theJournal- Returns:
- a
JournalEntrySearchSession - Throws:
NotFoundException- noJournalfound by the givenIdNullArgumentException-journalIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsJournalEntrySearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalEntrySearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getJournalEntryAdminSession
Gets theOsidSessionassociated with the journal entry administration service.- Returns:
- a
JournalEntryAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJournalEntryAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalEntryAdmin()} is {@code true} .
-
getJournalEntryAdminSessionForJournal
JournalEntryAdminSession getJournalEntryAdminSessionForJournal(Id journalId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the journal entry administration service for the given journal.- Parameters:
journalId- theIdof theJournal- Returns:
- a
JournalEntryAdminSession - Throws:
NotFoundException- noJournalfound by the givenIdNullArgumentException-journalIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsJournalEntryAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalEntryAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getJournalEntryNotificationSession
JournalEntryNotificationSession getJournalEntryNotificationSession(JournalEntryReceiver journalEntryReceiver) throws OperationFailedException Gets theOsidSessionassociated with the journal entry notification service.- Parameters:
journalEntryReceiver- the receiver- Returns:
- a
JournalEntryNotificationSession - Throws:
NullArgumentException-journalEntryReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsJournalEntryNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalEntryNotification()} is {@code true} .
-
getJournalEntryNotificationSessionForJournal
JournalEntryNotificationSession getJournalEntryNotificationSessionForJournal(JournalEntryReceiver journalEntryReceiver, Id journalId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the journal entry notification service for the given journal.- Parameters:
journalEntryReceiver- the receiverjournalId- theIdof theJournal- Returns:
- a
JournalEntryNotificationSession - Throws:
NotFoundException- noJournalfound by the givenIdNullArgumentException-journalEntryReceiverorjournalIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsJournalEntryNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalEntryNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getBranchLookupSession
Gets theOsidSessionassociated with the branch lookup service.- Returns:
a BranchLookupSession- Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsBranchLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBranchLookup()} is {@code true} .
-
getBranchLookupSessionForJournal
BranchLookupSession getBranchLookupSessionForJournal(Id journalId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the branch lookup service for the given journal.- Parameters:
journalId- theIdof the journal- Returns:
a BranchLookupSession- Throws:
NotFoundException-journalIdnot foundNullArgumentException-journalIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsBranchLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBranchLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getBranchQuerySession
Gets a branch query session.- Returns:
a BranchQuerySession- Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsBranchQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBranchQuery()} is {@code true} .
-
getBranchQuerySessionForJournal
BranchQuerySession getBranchQuerySessionForJournal(Id journalId) throws NotFoundException, OperationFailedException Gets a branch query session for the given journal.- Parameters:
journalId- theIdof the journal- Returns:
a BranchQuerySession- Throws:
NotFoundException-journalIdnot foundNullArgumentException-journalIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsBranchQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBranchQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getBranchSearchSession
Gets a branch search session.- Returns:
a BranchSearchSession- Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsBranchSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBranchSearch()} is {@code true} .
-
getBranchSearchSessionForJournal
BranchSearchSession getBranchSearchSessionForJournal(Id journalId) throws NotFoundException, OperationFailedException Gets a branch search session for the given journal.- Parameters:
journalId- theIdof the journal- Returns:
a BranchSearchSession- Throws:
NotFoundException-journalIdnot foundNullArgumentException-journalIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsBranchSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBranchSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getBranchAdminSession
Gets a branch administration session for creating, updating and deleting branches.- Returns:
a BranchAdminSession- Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsBranchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBranchAdmin()} is {@code true} .
-
getBranchAdminSessionForJournal
BranchAdminSession getBranchAdminSessionForJournal(Id journalId) throws NotFoundException, OperationFailedException Gets a branch administration session for the given journal.- Parameters:
journalId- theIdof the journal- Returns:
a BranchAdminSession- Throws:
NotFoundException-journalIdnot foundNullArgumentException-journalIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsBranchAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBranchAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
-
getBranchNotificationSession
BranchNotificationSession getBranchNotificationSession(BranchReceiver branchReceiver) throws OperationFailedException Gets the notification session for notifications pertaining to branch changes.- Parameters:
branchReceiver- the notification callback- Returns:
a BranchNotificationSession- Throws:
NullArgumentException-branchReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsBranchNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBranchNotification()} is {@code true} .
-
getBranchNotificationSessionForJournal
BranchNotificationSession getBranchNotificationSessionForJournal(BranchReceiver branchReceiver, Id journalId) throws NotFoundException, OperationFailedException Gets the branch notification session for the given journal.- Parameters:
branchReceiver- the notification callbackjournalId- theIdof the journal- Returns:
a BranchNotificationSession- Throws:
NotFoundException-journalIdnot foundNullArgumentException-branchReceiverorjournalIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsBranchNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBranchNotfication()} and {@code supportsVisibleFederation()} are {@code true} .
-
getBranchSmartJournalSession
BranchSmartJournalSession getBranchSmartJournalSession(Id journalId) throws NotFoundException, OperationFailedException Gets the session for managing dynamic branch journals.- Parameters:
journalId- theIdof the journal- Returns:
- a
BranchSmartJournalSession - Throws:
NotFoundException-journalIdnot foundNullArgumentException-journalIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsBranchSmartJournal()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBranchSmartJournal()} is {@code true} .
-
getJournalLookupSession
Gets theOsidSessionassociated with the journal lookup service.- Returns:
- a
JournalLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJournalLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalLookup()} is {@code true} .
-
getJournalQuerySession
Gets theOsidSessionassociated with the journal query service.- Returns:
- a
JournalQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJournalQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalQuery()} is {@code true} .
-
getJournalSearchSession
Gets theOsidSessionassociated with the journal search service.- Returns:
- a
JournalSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJournalSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalSearch()} is {@code true} .
-
getJournalAdminSession
Gets theOsidSessionassociated with the journal administrative service.- Returns:
- a
JournalAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJournalAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalAdmin()} is {@code true} .
-
getJournalNotificationSession
JournalNotificationSession getJournalNotificationSession(JournalReceiver journalReceiver) throws OperationFailedException Gets theOsidSessionassociated with the journal notification service.- Parameters:
journalReceiver- the receiver- Returns:
- a
JournalNotificationSession - Throws:
NullArgumentException-journalReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsJournalNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalNotification()} is {@code true} .
-
getJournalHierarchySession
Gets theOsidSessionassociated with the journal hierarchy service.- Returns:
- a
JournalHierarchySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJournalHierarchy()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalHierarchy()} is {@code true} .
-
getJournalHierarchyDesignSession
Gets theOsidSessionassociated with the journal hierarchy design service.- Returns:
- a
JournalHierarchyDesignSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJournalHierarchyDesign()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalHierarchyDesign()} is {@code true} .
-
getJournalingBatchManager
Gets aJournalingBatchManager.- Returns:
- a
JournalingBatchManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJournalingBatch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJournalingBatch()} is {@code true} .
-