OSID - osid.logging.LogEntrySearchSession Service Interface Definition

Interface	osid.logging.LogEntrySearchSession
Implements	`osid.logging.LogEntryQuerySession`
Description	This session provides methods for searching among log entries. The search query is constructed using the `LogEntryQuery.` `getLogEntriesByQuery()` is the basic search method and returns a list of log entries. A more advanced search may be performed with `getLogEntriesBySearch().` It accepts a `LogEntrySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getLogEntriesBySearch()` returns a `LogEntrySearchResults` that can be used to access the resulting `LogEntryList` or be used to perform a search within the result set through `LogEntrySearch.` This session defines views that offer differing behaviors for searching. federated log view: searches include entries in logs of which this log is an ancestor in the log hierarchy isolated log view: searches are restricted to entries in this log only
Method	getLogEntrySearch
Description	Gets a log entry search.
Return	`osid.logging.LogEntrySearch`		the log entry search
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntrySearchOrder
Description	Gets a log entry search order. The `LogEntrySearchOrder` is supplied to a `LogEntrySearch` to specify the ordering of results.
Return	`osid.logging.LogEntrySearchOrder`		the log entry search order
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.logging.LogEntryQuery`	`logEntryQuery`	the log entry query
Parameters	`osid.logging.LogEntrySearch`	`logEntrySearch`	the log entry search
Return	`osid.logging.LogEntrySearchResults`		the returned search results
Errors	NULL_ARGUMENT		`logEntryQuery` or `logEntrySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`logEntryQuery` or `logEntrySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntryQueryFromInspector
Description	Gets a log entry query from an inspector. The inspector is available from a `LogEntrySearchResults.`
Parameters	`osid.logging.LogQueryInspector`	`logEntryQueryInspector`	a log entry query inspector
Return	`osid.logging.LogEntryQuery`		the log entry query
Errors	NULL_ARGUMENT		`logEntryQueryInspector` is `null`
Errors	UNSUPPORTED		`logEntryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.