OSID - osid.journaling.JournalingManager Service Interface Definition

Interface	osid.journaling.JournalingManager
Implements	`osid.OsidManager`
Implements	`osid.journaling.JournalingProfile`
Description	The journaling manager provides access to journaling sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `JournalEntryLookupSession`: a session to lookup journal entries `JournalEntryQuerySession`: a session to query journal entries `JournalEntrySearchSession`: a session to search journal entries `JournalEntryAdminSession`: a session to manage journal entries `JournalEntryNotificationSession`: a session to subscribe to notifications of journal entry changes `BranchLookupSession`: a session to retrieve branches `BranchQuerySession`: a session to query branches `BranchSearchSession`: a session to search for branches `BranchAdminSession`: a session to create and delete brancehs `BranchNotificationSession`: a session to receive notifications pertaining to branch changes `BranchSmartJournalSession`: a session to manage smart branch journals `JournalLookupSession`: a session to retrieve journals `JournalQuerySession`: a session to query journals `JournalSearchSession`: a session to search for journals `JournalAdminSession`: a session to create, update and delete journals `JournalNotificationSession`: a session to receive notifications for changes in journals `JournalHierarchyTraversalSession`: a session to traverse hierarchies of journals `JournalHierarchyDesignSession`: a session to manage hierarchies of journals The journaling manager also provides a profile for determing the supported search types supported by this service.
Method	getJournalEntryLookupSession
Description	Gets the `OsidSession` associated with the journal entry lookup service.
Return	`osid.journaling.JournalEntryLookupSession`		a `JournalEntryLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsJournalEntryLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsJournalEntryLookup()` is `true`.
Method	getJournalEntryLookupSessionForJournal
Description	Gets the `OsidSession` associated with the journal entry lookup service for the given journal.
Parameters	`osid.id.Id`	`journalId`	the `Id` of the `Journal`
Return	`osid.journaling.JournalEntryLookupSession`		a `JournalEntryLookupSession`
Errors	NOT_FOUND		no `Journal` found by the given `Id`
	NULL_ARGUMENT		`journalId` 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 `OsidSession` associated with the journal entry query service.
Return	`osid.journaling.JournalEntryQuerySession`		a `JournalEntryQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsJournalEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsJournalEntryQuery()` is `true`.
Method	getJournalEntryQuerySessionForJournal
Description	Gets the `OsidSession` associated with the journal entry query service for the given journal.
Parameters	`osid.id.Id`	`journalId`	the `Id` of the `Journal`
Return	`osid.journaling.JournalEntryQuerySession`		a `JournalEntryQuerySession`
Errors	NOT_FOUND		no `Journal` found by the given `Id`
	NULL_ARGUMENT		`journalId` 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 `OsidSession` associated with the journal entry search service.
Return	`osid.journaling.JournalEntrySearchSession`		a `JournalEntrySearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsJournalEntrySearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsJournalEntrySearch()` is `true`.
Method	getJournalEntrySearchSessionForJournal
Description	Gets the `OsidSession` associated with the journal entry search service for the given journal.
Parameters	`osid.id.Id`	`journalId`	the `Id` of the `Journal`
Return	`osid.journaling.JournalEntrySearchSession`		a `JournalEntrySearchSession`
Errors	NOT_FOUND		no `Journal` found by the given `Id`
	NULL_ARGUMENT		`journalId` 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 `OsidSession` associated with the journal entry administration service.
Return	`osid.journaling.JournalEntryAdminSession`		a `JournalEntryAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsJournalEntryAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsJournalEntryAdmin()` is `true`.
Method	getJournalEntryAdminSessionForJournal
Description	Gets the `OsidSession` associated with the journal entry administration service for the given journal.
Parameters	`osid.id.Id`	`journalId`	the `Id` of the `Journal`
Return	`osid.journaling.JournalEntryAdminSession`		a `JournalEntryAdminSession`
Errors	NOT_FOUND		no `Journal` found by the given `Id`
	NULL_ARGUMENT		`journalId` 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 `OsidSession` associated with the journal entry notification service.
Parameters	`osid.journaling.JournalEntryReceiver`	`journalEntryReceiver`	the receiver
Return	`osid.journaling.JournalEntryNotificationSession`		a `JournalEntryNotificationSession`
Errors	NULL_ARGUMENT		`journalEntryReceiver` 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 `OsidSession` associated with the journal entry notification service for the given journal.
Parameters	`osid.journaling.JournalEntryReceiver`	`journalEntryReceiver`	the receiver
Parameters	`osid.id.Id`	`journalId`	the `Id` of the `Journal`
Return	`osid.journaling.JournalEntryNotificationSession`		a `JournalEntryNotificationSession`
Errors	NOT_FOUND		no `Journal` found by the given `Id`
	NULL_ARGUMENT		`journalEntryReceiver` or `journalId` 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 `OsidSession` associated with the branch lookup service.
Return	`osid.journaling.BranchLookupSession`		`a BranchLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBranchLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBranchLookup()` is `true`.
Method	getBranchLookupSessionForJournal
Description	Gets the `OsidSession` associated with the branch lookup service for the given journal.
Parameters	`osid.id.Id`	`journalId`	the `Id` of the journal
Return	`osid.journaling.BranchLookupSession`		`a BranchLookupSession`
Errors	NOT_FOUND		`journalId` not found
	NULL_ARGUMENT		`journalId` 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.
Return	`osid.journaling.BranchQuerySession`		`a BranchQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	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
Return	`osid.journaling.BranchQuerySession`		`a BranchQuerySession`
Errors	NOT_FOUND		`journalId` not found
	NULL_ARGUMENT		`journalId` 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.
Return	`osid.journaling.BranchSearchSession`		`a BranchSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	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
Return	`osid.journaling.BranchSearchSession`		`a BranchSearchSession`
Errors	NOT_FOUND		`journalId` not found
	NULL_ARGUMENT		`journalId` 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.
Return	`osid.journaling.BranchAdminSession`		`a BranchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	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
Return	`osid.journaling.BranchAdminSession`		`a BranchAdminSession`
Errors	NOT_FOUND		`journalId` not found
	NULL_ARGUMENT		`journalId` 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 notification session for notifications pertaining to branch changes.
Parameters	`osid.journaling.BranchReceiver`	`branchReceiver`	the notification callback
Return	`osid.journaling.BranchNotificationSession`		`a BranchNotificationSession`
Errors	NULL_ARGUMENT		`branchReceiver` 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`	the notification callback
Parameters	`osid.id.Id`	`journalId`	the `Id` of the journal
Return	`osid.journaling.BranchNotificationSession`		`a BranchNotificationSession`
Errors	NOT_FOUND		`journalId` not found
	NULL_ARGUMENT		`branchReceiver` or `journalId` 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
Return	`osid.journaling.BranchSmartJournalSession`		a `BranchSmartJournalSession`
Errors	NOT_FOUND		`journalId` not found
	NULL_ARGUMENT		`journalId` 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 `OsidSession` associated with the journal lookup service.
Return	`osid.journaling.JournalLookupSession`		a `JournalLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsJournalLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsJournalLookup()` is `true`.
Method	getJournalQuerySession
Description	Gets the `OsidSession` associated with the journal query service.
Return	`osid.journaling.JournalQuerySession`		a `JournalQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsJournalQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsJournalQuery()` is `true`.
Method	getJournalSearchSession
Description	Gets the `OsidSession` associated with the journal search service.
Return	`osid.journaling.JournalSearchSession`		a `JournalSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsJournalSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsJournalSearch()` is `true`.
Method	getJournalAdminSession
Description	Gets the `OsidSession` associated with the journal administrative service.
Return	`osid.journaling.JournalAdminSession`		a `JournalAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsJournalAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsJournalAdmin()` is `true`.
Method	getJournalNotificationSession
Description	Gets the `OsidSession` associated with the journal notification service.
Parameters	`osid.journaling.JournalReceiver`	`journalReceiver`	the receiver
Return	`osid.journaling.JournalNotificationSession`		a `JournalNotificationSession`
Errors	NULL_ARGUMENT		`journalReceiver` 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 `OsidSession` associated with the journal hierarchy service.
Return	`osid.journaling.JournalHierarchySession`		a `JournalHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsJournalHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsJournalHierarchy()` is `true`.
Method	getJournalHierarchyDesignSession
Description	Gets the `OsidSession` associated with the journal hierarchy design service.
Return	`osid.journaling.JournalHierarchyDesignSession`		a `JournalHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsJournalHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsJournalHierarchyDesign()` is `true`.
Method	getJournalingBatchManager
Description	Gets a `JournalingBatchManager`.
Return	`osid.journaling.batch.JournalingBatchManager`		a `JournalingBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsJournalingBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsJournalingBatch()` is `true`.