Interface | osid.journaling.JournalingProxyManager | ||
---|---|---|---|
Implements | osid.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
The journaling manager also provides a profile for determing the supported search types supported by this service. | ||
Method | getJournalEntryLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.JournalEntryLookupSession | a JournalEntryLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalEntryLookup() is false | ||
Compliance | optional | This method must be implemented if supportsJournalEntryLookup()
is true. | |
Method | getJournalEntryLookupSessionForJournal | ||
Description |
Gets the | ||
Parameters | osid.id.Id | journalId | the Id of the Journal |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.JournalEntryLookupSession | a JournalEntryLookupSession | |
Errors | NOT_FOUND | no Journal found by the given Id | |
NULL_ARGUMENT | journalId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalEntryLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsJournalEntryLookup()
and supportsVisibleFederation() are true | |
Method | getJournalEntryQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.JournalEntryQuerySession | a JournalEntryQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalEntryQuery() is false | ||
Compliance | optional | This method must be implemented if supportsJournalEntryQuery()
is true. | |
Method | getJournalEntryQuerySessionForJournal | ||
Description |
Gets the | ||
Parameters | osid.id.Id | journalId | the Id of the Journal |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.JournalEntryQuerySession | a JournalEntryQuerySession | |
Errors | NOT_FOUND | no Journal found by the given Id | |
NULL_ARGUMENT | journalId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalEntryQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsJournalEntryQuery()
and supportsVisibleFederation() are true | |
Method | getJournalEntrySearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.JournalEntrySearchSession | a JournalEntrySearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalEntrySearch() is false | ||
Compliance | optional | This method must be implemented if supportsJournalEntrySearch()
is true. | |
Method | getJournalEntrySearchSessionForJournal | ||
Description |
Gets the | ||
Parameters | osid.id.Id | journalId | the Id of the Journal |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.JournalEntrySearchSession | a JournalEntrySearchSession | |
Errors | NOT_FOUND | no Journal found by the given Id | |
NULL_ARGUMENT | journalId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalEntrySearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsJournalEntrySearch()
and supportsVisibleFederation() are true | |
Method | getJournalEntryAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.JournalEntryAdminSession | a JournalEntryAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalEntryAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsJournalEntryAdmin()
is true. | |
Method | getJournalEntryAdminSessionForJournal | ||
Description |
Gets the | ||
Parameters | osid.id.Id | journalId | the Id of the Journal |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.JournalEntryAdminSession | a JournalEntryAdminSession | |
Errors | NOT_FOUND | no Journal found by the given Id | |
NULL_ARGUMENT | journalId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalEntryAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsJournalEntryAdmin()
and supportsVisibleFederation() are true | |
Method | getJournalEntryNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.journaling.JournalEntryReceiver | journalEntryReceiver | the receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.JournalEntryNotificationSession | a JournalEntryNotificationSession | |
Errors | NULL_ARGUMENT | journalEntryReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalEntryNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsJournalEntryNotification() is true. | |
Method | getJournalEntryNotificationSessionForJournal | ||
Description |
Gets the | ||
Parameters | osid.journaling.JournalEntryReceiver | journalEntryReceiver | the receiver |
osid.id.Id | journalId | the Id of the Journal | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.JournalEntryNotificationSession | a JournalEntryNotificationSession | |
Errors | NOT_FOUND | no Journal found by the given Id | |
NULL_ARGUMENT | journalEntryReceiver, journalId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalEntryNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsJournalEntryNotification() and
supportsVisibleFederation() are true | |
Method | getBranchLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.BranchLookupSession | a BranchLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBranchLookup() is false | ||
Compliance | optional | This method must be implemented if supportsBranchLookup() is
true. | |
Method | getBranchLookupSessionForJournal | ||
Description |
Gets the | ||
Parameters | osid.id.Id | journalId | the Id of the journal |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.BranchLookupSession | a BranchLookupSession | |
Errors | NOT_FOUND | journalId not found | |
NULL_ARGUMENT | journalId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBranchLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsBranchLookup()
and supportsVisibleFederation() are true. | |
Method | getBranchQuerySession | ||
Description |
Gets a branch query session. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.BranchQuerySession | a BranchQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBranchQuery() is false | ||
Compliance | optional | This method must be implemented if supportsBranchQuery() is
true. | |
Method | getBranchQuerySessionForJournal | ||
Description |
Gets a branch query session for the given journal. | ||
Parameters | osid.id.Id | journalId | the Id of the journal |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.BranchQuerySession | a BranchQuerySession | |
Errors | NOT_FOUND | journalId not found | |
NULL_ARGUMENT | journalId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBranchQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsBranchQuery() and
supportsVisibleFederation() are true. | |
Method | getBranchSearchSession | ||
Description |
Gets a branch search session. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.BranchSearchSession | a BranchSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBranchSearch() is false | ||
Compliance | optional | This method must be implemented if supportsBranchSearch() is
true. | |
Method | getBranchSearchSessionForJournal | ||
Description |
Gets a branch search session for the given journal. | ||
Parameters | osid.id.Id | journalId | the Id of the journal |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.BranchSearchSession | a BranchSearchSession | |
Errors | NOT_FOUND | journalId not found | |
NULL_ARGUMENT | journalId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBranchSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsBranchSearch()
and supportsVisibleFederation() are true. | |
Method | getBranchAdminSession | ||
Description |
Gets a branch administration session for creating, updating and deleting branches. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.BranchAdminSession | a BranchAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBranchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsBranchAdmin() is
true. | |
Method | getBranchAdminSessionForJournal | ||
Description |
Gets a branch administration session for the given journal. | ||
Parameters | osid.id.Id | journalId | the Id of the journal |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.BranchAdminSession | a BranchAdminSession | |
Errors | NOT_FOUND | journalId not found | |
NULL_ARGUMENT | journalId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBranchAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsBranchAdmin() and
supportsVisibleFederation() are true. | |
Method | getBranchNotificationSession | ||
Description |
Gets the branch notification session for the given journal. | ||
Parameters | osid.journaling.BranchReceiver | branchReceiver | notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.BranchNotificationSession | a BranchNotificationSession | |
Errors | NULL_ARGUMENT | branchReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBranchNotification() is false | ||
Compliance | optional | This method must be implemented if supportsBranchNotification()
is true. | |
Method | getBranchNotificationSessionForJournal | ||
Description |
Gets the branch notification session for the given journal. | ||
Parameters | osid.journaling.BranchReceiver | branchReceiver | notification callback |
osid.id.Id | journalId | the Id of the journal | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.BranchNotificationSession | a BranchNotificationSession | |
Errors | NOT_FOUND | journalId not found | |
NULL_ARGUMENT | branchReceiver, journalId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBranchNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsBranchNotfication()
and supportsVisibleFederation() are true.
| |
Method | getBranchSmartJournalSession | ||
Description |
Gets the session for managing dynamic branch journals. | ||
Parameters | osid.id.Id | journalId | the Id of the journal |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.BranchSmartJournalSession | a BranchSmartJournalSession | |
Errors | NOT_FOUND | journalId not found | |
NULL_ARGUMENT | journalId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBranchSmartJournal() is false | ||
Compliance | optional | This method must be implemented if supportsBranchSmartJournal()
is true. | |
Method | getJournalLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.JournalLookupSession | a JournalLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalLookup() is false | ||
Compliance | optional | This method must be implemented if supportsJournalLookup()
is true. | |
Method | getJournalQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.JournalQuerySession | a JournalQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalQuery() is false | ||
Compliance | optional | This method must be implemented if supportsJournalQuery() is
true. | |
Method | getJournalSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.JournalSearchSession | a JournalSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalSearch() is false | ||
Compliance | optional | This method must be implemented if supportsJournalSearch()
is true. | |
Method | getJournalAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.JournalAdminSession | a JournalAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsJournalAdmin() is
true. | |
Method | getJournalNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.journaling.JournalReceiver | journalReceiver | the receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.journaling.JournalNotificationSession | a JournalNotificationSession | |
Errors | NULL_ARGUMENT | journalReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalNotification() is false | ||
Compliance | optional | This method must be implemented if supportsJournalNotification()
is true. | |
Method | getJournalHierarchySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.JournalHierarchySession | a JournalHierarchySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsJournalHierarchy()
is true. | |
Method | getJournalHierarchyDesignSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.journaling.JournalHierarchyDesignSession | a JournalHierarchyDesignSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsJournalHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsJournalHierarchyDesign()
is true. | |
Method | getJournalingBatchProxyManager | ||
Description |
Gets a | ||
Return | osid.journaling.batch.JournalingBatchProxyManager | a JournalingBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsJournalingBatch() is false | ||
Compliance | optional | This method must be implemented if supportsJournalingBatch()
is true. |