| Interface | osid.inquiry.AuditSearchSession | ||
|---|---|---|---|
| Implements | osid.inquiry.AuditQuerySession | ||
| Used By | osid.inquiry.InquiryManager | ||
osid.inquiry.InquiryProxyManager | |||
| Description |
This session provides methods for searching among
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.
Audits may have an audit record indicated by their
respective record types. The audit record is accessed via the
| ||
| Method | getAuditSearch | ||
| Description |
Gets an audit search. | ||
| Return | osid.inquiry.AuditSearch | the audit search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditSearchOrder | ||
| Description |
Gets an audit search order. The
| ||
| Return | osid.inquiry.AuditSearchOrder | the audit search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditsBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.inquiry.AuditQuery | auditQuery | the audit query |
osid.inquiry.AuditSearch | auditSearch | the audit search | |
| Return | osid.inquiry.AuditSearchResults | the audit search results | |
| Errors | NULL_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 | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditQueryFromInspector | ||
| Description |
Gets an audit query from an inspector. The inspector
is available from an | ||
| Parameters | osid.inquiry.AuditQueryInspector | auditQueryInspector | an audit query inspector |
| Return | osid.inquiry.AuditQuery | the audit query | |
| Errors | NULL_ARGUMENT | auditQueryInspector is null | |
| UNSUPPORTED | auditQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |