org.osid.journaling

Interface JournalingManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, JournalingProfile, OsidManager, OsidProfile, Sourceable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.journaling.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, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getJournalEntryLookupSession

JournalEntryLookupSession getJournalEntryLookupSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the journal entry lookup service.

Returns:

a JournalEntryLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalEntryLookup() is false

Compliance:

optional - This method must be implemented if supportsJournalEntryLookup() is true.

getJournalEntryLookupSessionForJournal

JournalEntryLookupSession getJournalEntryLookupSessionForJournal(Id journalId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the journal entry lookup service for the given journal.

Parameters:

journalId - the Id of the Journal

Returns:

a JournalEntryLookupSession

Throws:

NotFoundException - no Journal found by the given Id

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalEntryLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsJournalEntryLookup() and supportsVisibleFederation() are true

getJournalEntryQuerySession

JournalEntryQuerySession getJournalEntryQuerySession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the journal entry query service.

Returns:

a JournalEntryQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalEntryQuery() is false

Compliance:

optional - This method must be implemented if supportsJournalEntryQuery() is true.

getJournalEntryQuerySessionForJournal

JournalEntryQuerySession getJournalEntryQuerySessionForJournal(Id journalId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the journal entry query service for the given journal.

Parameters:

journalId - the Id of the Journal

Returns:

a JournalEntryQuerySession

Throws:

NotFoundException - no Journal found by the given Id

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalEntryQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsJournalEntryQuery() and supportsVisibleFederation() are true

getJournalEntrySearchSession

JournalEntrySearchSession getJournalEntrySearchSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the journal entry search service.

Returns:

a JournalEntrySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalEntrySearch() is false

Compliance:

optional - This method must be implemented if supportsJournalEntrySearch() is true.

getJournalEntrySearchSessionForJournal

JournalEntrySearchSession getJournalEntrySearchSessionForJournal(Id journalId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the journal entry search service for the given journal.

Parameters:

journalId - the Id of the Journal

Returns:

a JournalEntrySearchSession

Throws:

NotFoundException - no Journal found by the given Id

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalEntrySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsJournalEntrySearch() and supportsVisibleFederation() are true

getJournalEntryAdminSession

JournalEntryAdminSession getJournalEntryAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the journal entry administration service.

Returns:

a JournalEntryAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalEntryAdmin() is false

Compliance:

optional - This method must be implemented if supportsJournalEntryAdmin() is true.

getJournalEntryAdminSessionForJournal

JournalEntryAdminSession getJournalEntryAdminSessionForJournal(Id journalId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the journal entry administration service for the given journal.

Parameters:

journalId - the Id of the Journal

Returns:

a JournalEntryAdminSession

Throws:

NotFoundException - no Journal found by the given Id

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalEntryAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsJournalEntryAdmin() and supportsVisibleFederation() are true

getJournalEntryNotificationSession

JournalEntryNotificationSession getJournalEntryNotificationSession(JournalEntryReceiver journalEntryReceiver)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the journal entry notification service.

Parameters:

journalEntryReceiver - the receiver

Returns:

a JournalEntryNotificationSession

Throws:

NullArgumentException - journalEntryReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalEntryNotification() is false

Compliance:

optional - This method must be implemented if supportsJournalEntryNotification() is true.

getJournalEntryNotificationSessionForJournal

JournalEntryNotificationSession getJournalEntryNotificationSessionForJournal(JournalEntryReceiver journalEntryReceiver,
                                                                           Id journalId)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

Gets the OsidSession associated with the journal entry notification service for the given journal.

Parameters:

journalEntryReceiver - the receiver

journalId - the Id of the Journal

Returns:

a JournalEntryNotificationSession

Throws:

NotFoundException - no Journal found by the given Id

NullArgumentException - journalEntryReceiver or journalId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalEntryNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsJournalEntryNotification() and supportsVisibleFederation() are true

getBranchLookupSession

BranchLookupSession getBranchLookupSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the branch lookup service.

Returns:

a BranchLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchLookup() is false

Compliance:

optional - This method must be implemented if supportsBranchLookup() is true.

getBranchLookupSessionForJournal

BranchLookupSession getBranchLookupSessionForJournal(Id journalId)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the branch lookup service for the given journal.

Parameters:

journalId - the Id of the journal

Returns:

a BranchLookupSession

Throws:

NotFoundException - journalId not found

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsBranchLookup() and supportsVisibleFederation() are true.

getBranchQuerySession

BranchQuerySession getBranchQuerySession()
                                         throws OperationFailedException

Gets a branch query session.

Returns:

a BranchQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchQuery() is false

Compliance:

optional - This method must be implemented if supportsBranchQuery() is true.

getBranchQuerySessionForJournal

BranchQuerySession getBranchQuerySessionForJournal(Id journalId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets a branch query session for the given journal.

Parameters:

journalId - the Id of the journal

Returns:

a BranchQuerySession

Throws:

NotFoundException - journalId not found

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsBranchQuery() and supportsVisibleFederation() are true.

getBranchSearchSession

BranchSearchSession getBranchSearchSession()
                                           throws OperationFailedException

Gets a branch search session.

Returns:

a BranchSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchSearch() is false

Compliance:

optional - This method must be implemented if supportsBranchSearch() is true.

getBranchSearchSessionForJournal

BranchSearchSession getBranchSearchSessionForJournal(Id journalId)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets a branch search session for the given journal.

Parameters:

journalId - the Id of the journal

Returns:

a BranchSearchSession

Throws:

NotFoundException - journalId not found

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsBranchSearch() and supportsVisibleFederation() are true.

getBranchAdminSession

BranchAdminSession getBranchAdminSession()
                                         throws OperationFailedException

Gets a branch administration session for creating, updating and deleting branches.

Returns:

a BranchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchAdmin() is false

Compliance:

optional - This method must be implemented if supportsBranchAdmin() is true.

getBranchAdminSessionForJournal

BranchAdminSession getBranchAdminSessionForJournal(Id journalId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets a branch administration session for the given journal.

Parameters:

journalId - the Id of the journal

Returns:

a BranchAdminSession

Throws:

NotFoundException - journalId not found

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsBranchAdmin() and supportsVisibleFederation() are 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 - branchReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchNotification() is false

Compliance:

optional - This method must be implemented if supportsBranchNotification() is true.

getBranchNotificationSessionForJournal

BranchNotificationSession getBranchNotificationSessionForJournal(BranchReceiver branchReceiver,
                                                               Id journalId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the branch notification session for the given journal.

Parameters:

branchReceiver - the notification callback

journalId - the Id of the journal

Returns:

a BranchNotificationSession

Throws:

NotFoundException - journalId not found

NullArgumentException - branchReceiver or journalId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsBranchNotfication() and supportsVisibleFederation() are true.

getBranchSmartJournalSession

BranchSmartJournalSession getBranchSmartJournalSession(Id journalId)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the session for managing dynamic branch journals.

Parameters:

journalId - the Id of the journal

Returns:

a BranchSmartJournalSession

Throws:

NotFoundException - journalId not found

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchSmartJournal() is false

Compliance:

optional - This method must be implemented if supportsBranchSmartJournal() is true.

getJournalLookupSession

JournalLookupSession getJournalLookupSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the journal lookup service.

Returns:

a JournalLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalLookup() is false

Compliance:

optional - This method must be implemented if supportsJournalLookup() is true.

getJournalQuerySession

JournalQuerySession getJournalQuerySession()
                                           throws OperationFailedException

Gets the OsidSession associated with the journal query service.

Returns:

a JournalQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalQuery() is false

Compliance:

optional - This method must be implemented if supportsJournalQuery() is true.

getJournalSearchSession

JournalSearchSession getJournalSearchSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the journal search service.

Returns:

a JournalSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalSearch() is false

Compliance:

optional - This method must be implemented if supportsJournalSearch() is true.

getJournalAdminSession

JournalAdminSession getJournalAdminSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the journal administrative service.

Returns:

a JournalAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalAdmin() is false

Compliance:

optional - This method must be implemented if supportsJournalAdmin() is true.

getJournalNotificationSession

JournalNotificationSession getJournalNotificationSession(JournalReceiver journalReceiver)
                                                         throws OperationFailedException

Gets the OsidSession associated with the journal notification service.

Parameters:

journalReceiver - the receiver

Returns:

a JournalNotificationSession

Throws:

NullArgumentException - journalReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalNotification() is false

Compliance:

optional - This method must be implemented if supportsJournalNotification() is true.

getJournalHierarchySession

JournalHierarchySession getJournalHierarchySession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the journal hierarchy service.

Returns:

a JournalHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalHierarchy() is false

Compliance:

optional - This method must be implemented if supportsJournalHierarchy() is true.

getJournalHierarchyDesignSession

JournalHierarchyDesignSession getJournalHierarchyDesignSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the journal hierarchy design service.

Returns:

a JournalHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsJournalHierarchyDesign() is true.

getJournalingBatchManager

JournalingBatchManager getJournalingBatchManager()
                                                 throws OperationFailedException

Gets a JournalingBatchManager.

Returns:

a JournalingBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalingBatch() is false

Compliance:

optional - This method must be implemented if supportsJournalingBatch() is true.