OSID - osid.journaling.JournalEntrySearchSession Service Interface Definition

Interface	osid.journaling.JournalEntrySearchSession
Implements	`osid.journaling.JournalEntryQuerySession`
Description	This session provides methods for searching `JournalEntry` objects. The search query is constructed using the `JournalEntryQuery.` The journal record `Type` also specifies the record for the journal query. `getJournalEntriesByQuery()` is the basic search method and returns a list of `Journal` elements. A more advanced search may be performed with `getJournalEntriesBySearch().` It accepts a `JournalEntrySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getJournalEntriesBySearch()` returns a `JournalEntrySearchResults` that can be used to access the resulting `JournalEntryList` or be used to perform a search within the result set through `JournalEntrySearch.` 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	getJournalEntrySearch
Description	Gets a journal entry search.
Return	`osid.journaling.JournalEntrySearch`		the journal entry search
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntrySearchOrder
Description	Gets a journal entry search order. The `JournalEntrySearchOrder` is supplied to a `JournalEntrySearch` to specify the ordering of results.
Return	`osid.journaling.JournalEntrySearchOrder`		the journal entry search order
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntriesBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.journaling.JournalEntryQuery`	`journalEntryQuery`	the journal entry query
Parameters	`osid.journaling.JournalEntrySearch`	`journalEntrySearch`	the journal entry search
Return	`osid.journaling.JournalEntrySearchResults`		the search results
Errors	NULL_ARGUMENT		`journalEntryQuery` or `journalEntrySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`journalEntryQuery` or `journalEntrySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntryQueryFromInspector
Description	Gets a journal entry query from an inspector. The inspector is available from a `JournalEntrySearchResults.`
Parameters	`osid.journaling.JournalEntryQueryInspector`	`journalEntryQueryInspector`	a journal entry query inspector
Return	`osid.journaling.JournalEntryQuery`		the journal entry query
Errors	NULL_ARGUMENT		`journalEntryQueryInspector` is `null`
Errors	UNSUPPORTED		`journalEntryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.