OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.JournalingProxyManager
Implementsosid.OsidProxyManager
osid.journaling.JournalingProfile
Description

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.

MethodgetJournalEntryLookupSession
Description

Gets the OsidSession associated with the journal entry lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalEntryLookupSessiona JournalEntryLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalEntryLookup() is false
ComplianceoptionalThis method must be implemented if supportsJournalEntryLookup() is true.
MethodgetJournalEntryLookupSessionForJournal
Description

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

Parametersosid.id.IdjournalIdthe Id of the Journal
osid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalEntryLookupSessiona JournalEntryLookupSession
ErrorsNOT_FOUNDno Journal found by the given Id
NULL_ARGUMENT journalId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalEntryLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsJournalEntryLookup() and supportsVisibleFederation() are true
MethodgetJournalEntryQuerySession
Description

Gets the OsidSession associated with the journal entry query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalEntryQuerySessiona JournalEntryQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalEntryQuery() is false
ComplianceoptionalThis method must be implemented if supportsJournalEntryQuery() is true.
MethodgetJournalEntryQuerySessionForJournal
Description

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

Parametersosid.id.IdjournalIdthe Id of the Journal
osid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalEntryQuerySessiona JournalEntryQuerySession
ErrorsNOT_FOUNDno Journal found by the given Id
NULL_ARGUMENT journalId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalEntryQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsJournalEntryQuery() and supportsVisibleFederation() are true
MethodgetJournalEntrySearchSession
Description

Gets the OsidSession associated with the journal entry search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalEntrySearchSessiona JournalEntrySearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalEntrySearch() is false
ComplianceoptionalThis method must be implemented if supportsJournalEntrySearch() is true.
MethodgetJournalEntrySearchSessionForJournal
Description

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

Parametersosid.id.IdjournalIdthe Id of the Journal
osid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalEntrySearchSessiona JournalEntrySearchSession
ErrorsNOT_FOUNDno Journal found by the given Id
NULL_ARGUMENT journalId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalEntrySearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsJournalEntrySearch() and supportsVisibleFederation() are true
MethodgetJournalEntryAdminSession
Description

Gets the OsidSession associated with the journal entry administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalEntryAdminSessiona JournalEntryAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalEntryAdmin() is false
ComplianceoptionalThis method must be implemented if supportsJournalEntryAdmin() is true.
MethodgetJournalEntryAdminSessionForJournal
Description

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

Parametersosid.id.IdjournalIdthe Id of the Journal
osid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalEntryAdminSessiona JournalEntryAdminSession
ErrorsNOT_FOUNDno Journal found by the given Id
NULL_ARGUMENT journalId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalEntryAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsJournalEntryAdmin() and supportsVisibleFederation() are true
MethodgetJournalEntryNotificationSession
Description

Gets the OsidSession associated with the journal entry notification service.

Parametersosid.journaling.JournalEntryReceiverjournalEntryReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalEntryNotificationSessiona JournalEntryNotificationSession
ErrorsNULL_ARGUMENT journalEntryReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalEntryNotification() is false
ComplianceoptionalThis method must be implemented if supportsJournalEntryNotification() is true.
MethodgetJournalEntryNotificationSessionForJournal
Description

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

Parametersosid.journaling.JournalEntryReceiverjournalEntryReceiverthe receiver
osid.id.IdjournalIdthe Id of the Journal
osid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalEntryNotificationSessiona JournalEntryNotificationSession
ErrorsNOT_FOUNDno Journal found by the given Id
NULL_ARGUMENT journalEntryReceiver, journalId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalEntryNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsJournalEntryNotification() and supportsVisibleFederation() are true
MethodgetBranchLookupSession
Description

Gets the OsidSession associated with the branch lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.BranchLookupSession a BranchLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBranchLookup() is false
ComplianceoptionalThis method must be implemented if supportsBranchLookup() is true.
MethodgetBranchLookupSessionForJournal
Description

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

Parametersosid.id.IdjournalIdthe Id of the journal
osid.proxy.Proxyproxy a proxy
Returnosid.journaling.BranchLookupSession a BranchLookupSession
ErrorsNOT_FOUND journalId not found
NULL_ARGUMENT journalId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBranchLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBranchLookup() and supportsVisibleFederation() are true.
MethodgetBranchQuerySession
Description

Gets a branch query session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.BranchQuerySession a BranchQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBranchQuery() is false
ComplianceoptionalThis method must be implemented if supportsBranchQuery() is true.
MethodgetBranchQuerySessionForJournal
Description

Gets a branch query session for the given journal.

Parametersosid.id.IdjournalIdthe Id of the journal
osid.proxy.Proxyproxya proxy
Returnosid.journaling.BranchQuerySession a BranchQuerySession
ErrorsNOT_FOUND journalId not found
NULL_ARGUMENT journalId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBranchQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBranchQuery() and supportsVisibleFederation() are true.
MethodgetBranchSearchSession
Description

Gets a branch search session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.BranchSearchSession a BranchSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBranchSearch() is false
ComplianceoptionalThis method must be implemented if supportsBranchSearch() is true.
MethodgetBranchSearchSessionForJournal
Description

Gets a branch search session for the given journal.

Parametersosid.id.IdjournalIdthe Id of the journal
osid.proxy.Proxyproxya proxy
Returnosid.journaling.BranchSearchSession a BranchSearchSession
ErrorsNOT_FOUND journalId not found
NULL_ARGUMENT journalId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBranchSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBranchSearch() and supportsVisibleFederation() are true.
MethodgetBranchAdminSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.BranchAdminSession a BranchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBranchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBranchAdmin() is true.
MethodgetBranchAdminSessionForJournal
Description

Gets a branch administration session for the given journal.

Parametersosid.id.IdjournalIdthe Id of the journal
osid.proxy.Proxyproxya proxy
Returnosid.journaling.BranchAdminSession a BranchAdminSession
ErrorsNOT_FOUND journalId not found
NULL_ARGUMENT journalId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBranchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBranchAdmin() and supportsVisibleFederation() are true.
MethodgetBranchNotificationSession
Description

Gets the branch notification session for the given journal.

Parametersosid.journaling.BranchReceiverbranchReceivernotification callback
osid.proxy.Proxyproxya proxy
Returnosid.journaling.BranchNotificationSession a BranchNotificationSession
ErrorsNULL_ARGUMENT branchReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBranchNotification() is false
ComplianceoptionalThis method must be implemented if supportsBranchNotification() is true.
MethodgetBranchNotificationSessionForJournal
Description

Gets the branch notification session for the given journal.

Parametersosid.journaling.BranchReceiverbranchReceivernotification callback
osid.id.IdjournalIdthe Id of the journal
osid.proxy.Proxyproxya proxy
Returnosid.journaling.BranchNotificationSession a BranchNotificationSession
ErrorsNOT_FOUND journalId not found
NULL_ARGUMENT branchReceiver, journalId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBranchNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBranchNotfication() and supportsVisibleFederation() are true.
MethodgetBranchSmartJournalSession
Description

Gets the session for managing dynamic branch journals.

Parametersosid.id.IdjournalIdthe Id of the journal
osid.proxy.Proxyproxya proxy
Returnosid.journaling.BranchSmartJournalSessiona BranchSmartJournalSession
ErrorsNOT_FOUND journalId not found
NULL_ARGUMENT journalId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBranchSmartJournal() is false
ComplianceoptionalThis method must be implemented if supportsBranchSmartJournal() is true.
MethodgetJournalLookupSession
Description

Gets the OsidSession associated with the journal lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalLookupSessiona JournalLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalLookup() is false
ComplianceoptionalThis method must be implemented if supportsJournalLookup() is true.
MethodgetJournalQuerySession
Description

Gets the OsidSession associated with the journal query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalQuerySessiona JournalQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalQuery() is false
ComplianceoptionalThis method must be implemented if supportsJournalQuery() is true.
MethodgetJournalSearchSession
Description

Gets the OsidSession associated with the journal search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalSearchSessiona JournalSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalSearch() is false
ComplianceoptionalThis method must be implemented if supportsJournalSearch() is true.
MethodgetJournalAdminSession
Description

Gets the OsidSession associated with the journal administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalAdminSessiona JournalAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalAdmin() is false
ComplianceoptionalThis method must be implemented if supportsJournalAdmin() is true.
MethodgetJournalNotificationSession
Description

Gets the OsidSession associated with the journal notification service.

Parametersosid.journaling.JournalReceiverjournalReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalNotificationSessiona JournalNotificationSession
ErrorsNULL_ARGUMENT journalReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalNotification() is false
ComplianceoptionalThis method must be implemented if supportsJournalNotification() is true.
MethodgetJournalHierarchySession
Description

Gets the OsidSession associated with the journal hierarchy service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalHierarchySessiona JournalHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsJournalHierarchy() is true.
MethodgetJournalHierarchyDesignSession
Description

Gets the OsidSession associated with the journal hierarchy design service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.journaling.JournalHierarchyDesignSessiona JournalHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsJournalHierarchyDesign() is true.
MethodgetJournalingBatchProxyManager
Description

Gets a JournalingBatchProxyManager.

Returnosid.journaling.batch.JournalingBatchProxyManagera JournalingBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJournalingBatch() is false
ComplianceoptionalThis method must be implemented if supportsJournalingBatch() is true.