OSID - osid.inquiry.AuditQuerySession Service Interface Definition

Interface	osid.inquiry.AuditQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.inquiry.AuditSearchSession`
Used By	`osid.inquiry.InquiryManager`
Used By	`osid.inquiry.InquiryProxyManager`
Description	This session provides methods for searching among `Audits`. The search query is constructed using the `AuditQuery`. This session defines views that offer differing behaviors for searching. federated action group view: searches include audits in action groups of which this action group is an ancestor in the action group hierarchy isolated action group view: searches are restricted to audits in this action group Audits may have a query record indicated by their respective record types. The query record is accessed via the `AuditQuery`.
Method	getInquestId
Description	Gets the `Inquest` `Id` associated with this session.
Return	`osid.id.Id`		the `Inquest Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getInquest
Description	Gets the `Inquest` associated with this session.
Return	`osid.inquiry.Inquest`		the inquest
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchAudits
Description	Tests if this user can perform `Audit` lookups. 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 not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedInquestView
Description	Federates the view for methods in this session. A federated view will include audits in inquests which are children of this action group in the inquest hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedInquestView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this inquest only.
Compliance	`mandatory`		This method is must be implemented.
Method	getAuditQuery
Description	Gets an audit query.
Return	`osid.inquiry.AuditQuery`		the audit query
Compliance	`mandatory`		This method must be implemented.
Method	getAuditsByQuery
Description	Gets a list of `Audits` matching the given audit query.
Parameters	`osid.inquiry.AuditQuery`	`auditQuery`	the audit query
Return	`osid.inquiry.AuditList`		the returned `AuditList`
Errors	NULL_ARGUMENT		`auditQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auditQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.