org.osid.journaling

Interface JournalingProxyManager

All Superinterfaces:

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

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the journal entry lookup service.

Parameters:

proxy - a proxy

Returns:

a JournalEntryLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

journalId - the Id of the Journal

proxy - a proxy

Returns:

a JournalEntryLookupSession

Throws:

NotFoundException - no Journal found by the given Id

NullArgumentException - journalId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the journal entry query service.

Parameters:

proxy - a proxy

Returns:

a JournalEntryQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

journalId - the Id of the Journal

proxy - a proxy

Returns:

a JournalEntryQuerySession

Throws:

NotFoundException - no Journal found by the given Id

NullArgumentException - journalId or proxy 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(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the journal entry search service.

Parameters:

proxy - a proxy

Returns:

a JournalEntrySearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

journalId - the Id of the Journal

proxy - a proxy

Returns:

a JournalEntrySearchSession

Throws:

NotFoundException - no Journal found by the given Id

NullArgumentException - journalId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the journal entry administration service.

Parameters:

proxy - a proxy

Returns:

a JournalEntryAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

journalId - the Id of the Journal

proxy - a proxy

Returns:

a JournalEntryAdminSession

Throws:

NotFoundException - no Journal found by the given Id

NullArgumentException - journalId or proxy 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,
                                                                 Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the journal entry notification service.

Parameters:

journalEntryReceiver - the receiver

proxy - a proxy

Returns:

a JournalEntryNotificationSession

Throws:

NullArgumentException - journalEntryReceiver or proxy 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,
                                                                           Proxy proxy)
                                                                             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

proxy - a proxy

Returns:

a JournalEntryNotificationSession

Throws:

NotFoundException - no Journal found by the given Id

NullArgumentException - journalEntryReceiver, journalId or proxy 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(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the branch lookup service.

Parameters:

proxy - a proxy

Returns:

a BranchLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

journalId - the Id of the journal

proxy - a proxy

Returns:

a BranchLookupSession

Throws:

NotFoundException - journalId not found

NullArgumentException - journalId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets a branch query session.

Parameters:

proxy - a proxy

Returns:

a BranchQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets a branch query session for the given journal.

Parameters:

journalId - the Id of the journal

proxy - a proxy

Returns:

a BranchQuerySession

Throws:

NotFoundException - journalId not found

NullArgumentException - journalId or proxy 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(Proxy proxy)
                                           throws OperationFailedException

Gets a branch search session.

Parameters:

proxy - a proxy

Returns:

a BranchSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets a branch search session for the given journal.

Parameters:

journalId - the Id of the journal

proxy - a proxy

Returns:

a BranchSearchSession

Throws:

NotFoundException - journalId not found

NullArgumentException - journalId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a BranchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets a branch administration session for the given journal.

Parameters:

journalId - the Id of the journal

proxy - a proxy

Returns:

a BranchAdminSession

Throws:

NotFoundException - journalId not found

NullArgumentException - journalId or proxy 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,
                                                     Proxy proxy)
                                                       throws OperationFailedException

Gets the branch notification session for the given journal.

Parameters:

branchReceiver - notification callback

proxy - a proxy

Returns:

a BranchNotificationSession

Throws:

NullArgumentException - branchReceiver or proxy 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,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the branch notification session for the given journal.

Parameters:

branchReceiver - notification callback

journalId - the Id of the journal

proxy - a proxy

Returns:

a BranchNotificationSession

Throws:

NotFoundException - journalId not found

NullArgumentException - branchReceiver, journalId or proxy 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,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the session for managing dynamic branch journals.

Parameters:

journalId - the Id of the journal

proxy - a proxy

Returns:

a BranchSmartJournalSession

Throws:

NotFoundException - journalId not found

NullArgumentException - journalId or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the journal lookup service.

Parameters:

proxy - a proxy

Returns:

a JournalLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalLookup() is false

Compliance:

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

getJournalQuerySession

JournalQuerySession getJournalQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the journal query service.

Parameters:

proxy - a proxy

Returns:

a JournalQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalQuery() is false

Compliance:

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

getJournalSearchSession

JournalSearchSession getJournalSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the journal search service.

Parameters:

proxy - a proxy

Returns:

a JournalSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalSearch() is false

Compliance:

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

getJournalAdminSession

JournalAdminSession getJournalAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the journal administrative service.

Parameters:

proxy - a proxy

Returns:

a JournalAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the journal notification service.

Parameters:

journalReceiver - the receiver

proxy - a proxy

Returns:

a JournalNotificationSession

Throws:

NullArgumentException - journalReceiver or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the journal hierarchy service.

Parameters:

proxy - a proxy

Returns:

a JournalHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalHierarchy() is false

Compliance:

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

getJournalHierarchyDesignSession

JournalHierarchyDesignSession getJournalHierarchyDesignSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the journal hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a JournalHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalHierarchyDesign() is false

Compliance:

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

getJournalingBatchProxyManager

JournalingBatchProxyManager getJournalingBatchProxyManager()
                                                           throws OperationFailedException

Gets a JournalingBatchProxyManager.

Returns:

a JournalingBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJournalingBatch() is false

Compliance:

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