OSID - osid.journaling.JournalEntryQuerySession Service Interface Definition

Interface	osid.journaling.JournalEntryQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.journaling.JournalEntrySearchSession`
Used By	`osid.journaling.JournalingManager`
Used By	`osid.journaling.JournalingProxyManager`
Description	This session provides methods for searching `JournalEntries`. The search query is constructed using the `JournalEntryQuery`. The journal record `Type` also specifies the interface for the journal query. Journal entries may have a query record indicated by their respective record types. The query record is accessed via the `JournalEntryQuery`. The returns in this session may not be cast directly to these interfaces.
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	canSearchJournalEntries
Description	Tests if this user can perform `Journal` searches. 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 wish not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method 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 searches to this journal only.
Compliance	`mandatory`		This method is must be implemented.
Method	getJournalEntryQuery
Description	Gets a journal entry query.
Return	`osid.journaling.JournalEntryQuery`		the journal entry query
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesByQuery
Description	Gets a list of journal entries matching the given journal entry query.
Parameters	`osid.journaling.JournalEntryQuery`	`journalEntryQuery`	the journal entry query
Return	`osid.journaling.JournalEntryList`		the returned `JournalEntryList`
Errors	NULL_ARGUMENT		`journalEntryQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`journalQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.