OSID Logo
OSID Specifications
inquiry package
Version 3.1.0
Interfaceosid.inquiry.AuditSearchSession
Implementsosid.inquiry.AuditQuerySession
Used Byosid.inquiry.InquiryManager
osid.inquiry.InquiryProxyManager
Description

This session provides methods for searching among Audits. The search query is constructed using the AudityQuery.

getAuditsByQuery() is the basic search method and returns a list of Audits. A more advanced search may be performed with getAuditsBySearch(). It accepts an AuditSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAuditsBySearch() returns an AuditSearchResults that can be used to access the resulting AuditList or be used to perform a search within the result set through AuditSearch.

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 an audit record indicated by their respective record types. The audit record is accessed via the AuditQuery.

MethodgetAuditSearch
Description

Gets an audit search.

Returnosid.inquiry.AuditSearch the audit search
Compliancemandatory This method must be implemented.
MethodgetAuditSearchOrder
Description

Gets an audit search order. The AuditSearchOrder is supplied to an AuditSearch to specify the ordering of results.

Returnosid.inquiry.AuditSearchOrder the audit search order
Compliancemandatory This method must be implemented.
MethodgetAuditsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.inquiry.AuditQueryauditQuery the audit query
osid.inquiry.AuditSearchauditSearch the audit search
Returnosid.inquiry.AuditSearchResults the audit search results
ErrorsNULL_ARGUMENT auditQuery or auditSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED auditQuery or auditSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetAuditQueryFromInspector
Description

Gets an audit query from an inspector. The inspector is available from an AuditSearchResults.

Parametersosid.inquiry.AuditQueryInspectorauditQueryInspector an audit query inspector
Returnosid.inquiry.AuditQuery the audit query
ErrorsNULL_ARGUMENT auditQueryInspector is null
UNSUPPORTED auditQueryInspector is not of this service
Compliancemandatory This method must be implemented.