Interface | osid.inquiry.AuditSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getAudits | ||
Description |
Gets the audit list resulting from a search. | ||
Return | osid.inquiry.AuditList | the audit list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuditQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.inquiry.AuditQueryInspector | the audit query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuditSearchResultsRecord | ||
Description |
Gets the audit search results record corresponding to
the given audit search record | ||
Parameters | osid.type.Type | auditSearchRecordType | an audit search record type |
Return | osid.inquiry.records.AuditSearchResultsRecord | the audit search results record | |
Errors | NULL_ARGUMENT | auditSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(auditSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |