OSID - osid.journaling.JournalSearchSession Service Interface Definition

Interface	osid.journaling.JournalSearchSession
Implements	`osid.journaling.JournalQuerySession`
Used By	`osid.journaling.JournalingManager`
Used By	`osid.journaling.JournalingProxyManager`
Description	This session provides methods for searching `Journals`. The search query is constructed using the `JournalQuery`. The journal record `Type` also specifies the record for the journal query. `getJournalsByQuery()` is the basic search method and returns a list of `Journal` elements. A more advanced search may be performed with `getJournalsBySearch()`.It accepts a `JournalSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getJournalsBySearch()` returns a `JournalSearchResults` that can be used to access the resulting `JournalList` or be used to perform a search within the result set through `JournalSearch`. Journals may have a query record indicated by their respective record types. The query record is accessed via the `JournalQuery`. The returns in this session may not be cast directly to these interfaces.
Method	getJournalSearch
Description	Gets a journal search.
Return	`osid.journaling.JournalSearch`		the journal search
Compliance	`mandatory`		This method must be implemented.
Method	getJournalSearchOrder
Description	Gets a journal search order. The `JournalSearchOrder` is supplied to a `JournalSearch` to specify the ordering of results.
Return	`osid.journaling.JournalSearchOrder`		the journal search order
Compliance	`mandatory`		This method must be implemented.
Method	getJournalsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.journaling.JournalQuery`	`journalQuery`	the journal query
Parameters	`osid.journaling.JournalSearch`	`journalSearch`	the journal search
Return	`osid.journaling.JournalSearchResults`		the journal search results
Errors	NULL_ARGUMENT		`journalQuery` or `journalSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`journalQuery` or `journalSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getJournalQueryFromInspector
Description	Gets a journal query from an inspector. The inspector is available from a `JournalSearchResults`.
Parameters	`osid.journaling.JournalQueryInspector`	`journalQueryInspector`	a journal query inspector
Return	`osid.journaling.JournalQuery`		the journal query
Errors	NULL_ARGUMENT		`journalQueryInspector` is `null`
Errors	UNSUPPORTED		`journalQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.