OSID - osid.logging.LogEntryQuerySession Service Interface Definition

Interface	osid.logging.LogEntryQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among log entries. The search query is constructed using the `LogEntryQuery.` 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	getLogId
Description	Gets the `Log` `Id` associated with this session.
Return	`osid.id.Id`		the `Log Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getLog
Description	Gets the `Log` associated with this session.
Return	`osid.logging.Log`		the `Log` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchLogEntries
Description	Tests if this user can perform `LogEntry` 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 opt 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	useFederatedLogView
Description	Federates the view for methods in this session. A federated view will include entries in logs which are children of this log in the log hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedLogView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this log only.
Compliance	`mandatory`		This method is must be implemented.
Method	getLogEntryQuery
Description	Gets a log entry query
Return	`osid.logging.LogEntryQuery`		the log entry query
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntriesByQuery
Description	Gets a list of log entries matching the given log entry query
Parameters	`osid.logging.LogEntryQuery`	`logEntryQuery`	the log entry query
Return	`osid.logging.LogEntryList`		the returned `LogEntryList`
Errors	NULL_ARGUMENT		`logEntryQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`logEntryQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.