Interface JournalingProxyManager

All Superinterfaces:

AutoCloseable, Closeable, JournalingProfile, OsidProfile, OsidProxyManager, 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

Modifier and Type	Method	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 Closeable

close

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, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getBranchRecordTypes()	Gets all the branch record types supported.
TypeList	getBranchSearchRecordTypes()	Gets all the branch search record types supported.
TypeList	getJournalEntryRecordTypes()	Gets the supported JournalEntry record types.
TypeList	getJournalEntrySearchRecordTypes()	Gets the supported journal entry search record types.
TypeList	getJournalRecordTypes()	Gets the supported Journal record types.
TypeList	getJournalSearchRecordTypes()	Gets the supported journal search record types.
boolean	supportsBranchAdmin()	Tests if branch administration is supported.
boolean	supportsBranchLookup()	Tests if branch lookup is supported.
boolean	supportsBranchNotification()	Tests if branch notification is supported.
boolean	supportsBranchQuery()	Tests if branch query is supported.
boolean	supportsBranchRecordType(Type branchRecordType)	Tests if a given branch record type is supported.
boolean	supportsBranchSearch()	Tests if branch search is supported.
boolean	supportsBranchSearchRecordType(Type branchSearchRecordType)	Tests if a given branch search type is supported.
boolean	supportsBranchSmartJournal()	Tests if branch smart journals are available.
boolean	supportsJournalAdmin()	Tests for the availability of a journal administrative service for creating and deleting journals.
boolean	supportsJournalEntryAdmin()	Tests if searching for journal entries is available.
boolean	supportsJournalEntryLookup()	Tests for the availability of a journal entry lookup service.
boolean	supportsJournalEntryNotification()	Tests if journal entry notification is available.
boolean	supportsJournalEntryQuery()	Tests if querying journal entries is available.
boolean	supportsJournalEntryRecordType(Type journalEntryRecordType)	Tests if the given JournalEntry record type is supported.
boolean	supportsJournalEntrySearch()	Tests if searching for journal entries is available.
boolean	supportsJournalEntrySearchRecordType(Type journalEntrySearchRecordType)	Tests if the given journal entry search record type is supported.
boolean	supportsJournalHierarchy()	Tests for the availability of a journal hierarchy traversal service.
boolean	supportsJournalHierarchyDesign()	Tests for the availability of a journal hierarchy design service.
boolean	supportsJournalLookup()	Tests for the availability of a journal lookup service.
boolean	supportsJournalngBatch()	Tests for the availability of a journaling batch service.
boolean	supportsJournalNotification()	Tests for the availability of a journal notification service.
boolean	supportsJournalQuery()	Tests if querying journals is available.
boolean	supportsJournalRecordType(Type journalRecordType)	Tests if the given Journal record type is supported.
boolean	supportsJournalSearch()	Tests if searching for journals is available.
boolean	supportsJournalSearchRecordType(Type journalSearchRecordType)	Tests if the given journal search record type is supported.
boolean	supportsVisibleFederation()	Tests if any journal federation is exposed.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids.
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsJournalEntryLookup()} is {@code 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 {@code supportsJournalEntryLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsJournalEntryQuery()} is {@code 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 {@code supportsJournalEntryQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsJournalEntrySearch()} is {@code 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 {@code supportsJournalEntrySearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsJournalEntryAdmin()} is {@code 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 {@code supportsJournalEntryAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsJournalEntryNotification()} is {@code 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 {@code supportsJournalEntryNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsBranchLookup()} is {@code 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 {@code supportsBranchLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsBranchQuery()} is {@code 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 {@code supportsBranchQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsBranchSearch()} is {@code 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 {@code supportsBranchSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsBranchAdmin()} is {@code 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 {@code supportsBranchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsBranchNotification()} is {@code 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 {@code supportsBranchNotfication()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsBranchSmartJournal()} is {@code 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 {@code supportsJournalLookup()} is {@code 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 {@code supportsJournalQuery()} is {@code 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 {@code supportsJournalSearch()} is {@code 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 {@code supportsJournalAdmin()} is {@code 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 {@code supportsJournalNotification()} is {@code 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 {@code supportsJournalHierarchy()} is {@code 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 {@code supportsJournalHierarchyDesign()} is {@code 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 {@code supportsJournalingBatch()} is {@code true}.