OSID - osid.journaling.JournalEntryLookupSession Service Interface Definition

Interface	osid.journaling.JournalEntryLookupSession
Implements	`osid.OsidSession`
Used By	`osid.journaling.JournalingManager`
Used By	`osid.journaling.JournalingProxyManager`
Description	This session defines methods for retrieving journal entries. A `JournalEntry` is a version entry for an OSID `Id`. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated journal view: All journal entry methods in this session operate, retrieve and pertain to journal entries defined explicitly in the current journal. Using an isolated view is useful for managing journal entries with the `JournalEntryAdminSession`. federated journal view: All journal entry lookup methods in this session operate, retrieve and pertain to all journal entries defined in this journal and any other journals implicitly available in this journal through journal inheritence. The methods `useFederatedJournalView()` and `useIsolatedJournalView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getJournalId
Description	Gets the `Journal` `Id` associated with this session.
Return	`osid.id.Id`		the `Journal Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getJournal
Description	Gets the `Journal` associated with this session.
Return	`osid.journaling.Journal`		the journal
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupJournalEntries
Description	Tests if this user can lookup jpurnal entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer lookup operations.
Return	`boolean`		`false` if journal reading methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeJournalEntryView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryJournalEntryView
Description	A complete view of the `JournalEntry` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedJournalView
Description	Federates the view for methods in this session. A federated view will include entries in journals which are children of this journal in the journal hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedJournalView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this journal only.
Compliance	`mandatory`		This method is must be implemented.
Method	getJournalEntry
Description	Gets the `JournalEntry` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `JournalEntry` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `JournalEntry` and retained for compatibility.
Parameters	`osid.id.Id`	`journalEntryId`	the `Id` of the `JournalEntry` to retrieve
Return	`osid.journaling.JournalEntry`		the returned `JournalEntry`
Errors	NOT_FOUND		no `JournalEntry` found with the given `Id`
	NULL_ARGUMENT		`journalEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesByIds
Description	Gets a `JournalEntryList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the entries specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible entries may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`journalEntryIds`	the list of `Ids` to retrieve
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntry list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`journalEntryIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesByGenusType
Description	Gets a `JournalEntryList` corresponding to the given journal entry genus `Type` which does not include journal entries of genus types derived from the specified `Type`. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Parameters	`osid.type.Type`	`journalEntryGenusType`	a journal entry genus type
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntry` list
Errors	NULL_ARGUMENT		`journalEntryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesByParentGenusType
Description	Gets a `JournalEntryList` corresponding to the given journal entry genus `Type` and include any additional journal entries with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Parameters	`osid.type.Type`	`journalEntryGenusType`	a journal entry genus type
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntry` list
Errors	NULL_ARGUMENT		`journalEntryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesByRecordType
Description	Gets a `JournalEntryList` containing the given journal entry record `Type`. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Parameters	`osid.type.Type`	`journalEntryRecordType`	a journal entry record type
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntry` list
Errors	NULL_ARGUMENT		`journalEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesForBranch
Description	Gets a list of journal entries corresponding to a branch `Id`. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Parameters	`osid.id.Id`	`branchId`	the `Id` of the branch
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntryList`
Errors	NULL_ARGUMENT		`branchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesByDateForBranch
Description	Gets the journal entry corresponding to a resource `Id` and date. The entries returned have a date equal to or more recent than the requested date. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Parameters	`osid.id.Id`	`branchId`	the `Id` of the branch
Parameters	`osid.calendaring.DateTime`	`date`	from date
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntryList`
Errors	NULL_ARGUMENT		`branchId` or `date` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesByDateRangeForBranch
Description	Gets a list of journal entries corresponding to a branch `Id` and date range. Entries are returned with dates that fall between the requested dates inclusive. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Parameters	`osid.id.Id`	`branchId`	the `Id` of the branch
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntryList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`branchId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesForSource
Description	Gets a list of journal entries corresponding to a source `Id`. A source `Id` of any version may be requested. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Parameters	`osid.id.Id`	`sourceId`	the `Id` of the source
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntryList`
Errors	NULL_ARGUMENT		`sourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesByDateForSource
Description	Gets the journal entry corresponding to a source `Id` and date. The entry returned has a date equal to or more recent than the requested date. The `sourceId` may correspond to any version. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Parameters	`osid.id.Id`	`sourceId`	a source `Id`
Parameters	`osid.calendaring.DateTime`	`date`	from date
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntryList`
Errors	NULL_ARGUMENT		`sourceId` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesByDateRangeForSource
Description	Gets a list of journal entries corresponding to a source `Id` and date range. Entries are returned with dates that fall between the requested dates inclusive. The `sourceId` may correspond to any version. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Parameters	`osid.id.Id`	`sourceId`	a source `Id`
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntryList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`sourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesForBranchAndSource
Description	Gets a list of journal entries corresponding to a branch and source `Id`. A source `Id` of any version may be requested. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Parameters	`osid.id.Id`	`branchId`	the `Id` of the branch
Parameters	`osid.id.Id`	`sourceId`	the `Id` of the source
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntryList`
Errors	NULL_ARGUMENT		`branchId` or `sourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesByDateForBranchAndSource
Description	Gets the journal entry corresponding to a branch and source `Id` and date. The entry returned has a date equal to or more recent than the requested date. The `sourceId` may correspond to any version. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Parameters	`osid.id.Id`	`branchId`	a branch `Id`
	`osid.id.Id`	`sourceId`	the `Id` of the source
	`osid.calendaring.DateTime`	`date`	from date
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntryList`
Errors	NULL_ARGUMENT		`branchId, sourceId` or `date` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesByDateRangeForBranchAndSource
Description	Gets a list of journal entries corresponding to a branch and source `Id` and date range. Entries are returned with dates that fall between the requested dates inclusive. The `sourceId` may correspond to any version In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Parameters	`osid.id.Id`	`branchId`	a branch `Id`
	`osid.id.Id`	`sourceId`	the `Id` of the source
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntryList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`branchId, sourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesForResource
Description	Gets a list of journal entries corresponding to a resource `Id`. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntryList`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesByDateForResource
Description	Gets the journal entry corresponding to a resource `Id` and date. The entry returned has a date equal to or more recent than the requested date. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource
Parameters	`osid.calendaring.DateTime`	`date`	from date
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntryList`
Errors	NULL_ARGUMENT		`resourceId` or `date` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesByDateRangeForResource
Description	Gets a list of journal entries corresponding to a resource `Id` and date range. Entries are returned with dates that fall between the requested dates inclusive. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntryList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`resourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntries
Description	Gets all journal entries. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In both cases, the order of the set is not specifed. In plenary mode, the returned list contains all known journal entries or an error results. Otherwise, the returned list may contain only those journal entries that are accessible through this session.
Return	`osid.journaling.JournalEntryList`		a list of journal entries
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.