Interface | osid.inquiry.AuditQuery | ||
---|---|---|---|
Implements | osid.OsidGovernatorQuery | ||
Description |
This is the query for searching audits. Each method match
specifies an | ||
Method | matchInquiryId | ||
Description |
Sets the inquiry | ||
Parameters | osid.id.Id | inquiryId | the inquiry Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | inquiryId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearInquiryIdTerms | ||
Description |
Clears the inquiry | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsInquiryQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an inquiry query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getInquiryQuery | ||
Description |
Gets the query for an inquiry. Multiple retrievals
produce a nested | ||
Return | osid.inquiry.InquiryQuery | the inquiry query | |
Errors | UNIMPLEMENTED | supportsInquiryQuery() is false | |
Compliance | optional | This method must be implemented if supportsInquiryQuery() is
true. | |
Method | matchInquiry | ||
Description |
Matches audits with any inquiry. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearInquiryTerms | ||
Description |
Clears the inquiry query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchInquestId | ||
Description |
Sets the inquest | ||
Parameters | osid.id.Id | inquestId | the inquest Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | inquestId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearInquestIdTerms | ||
Description |
Clears the inquest | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsInquestQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an inquest query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getInquestQuery | ||
Description |
Gets the query for an inquest. Multiple retrievals
produce a nested | ||
Return | osid.inquiry.InquestQuery | the inquest query | |
Errors | UNIMPLEMENTED | supportsInquestQuery() is false | |
Compliance | optional | This method must be implemented if supportsInquestQuery() is
true. | |
Method | clearInquestTerms | ||
Description |
Clears the inquest query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuditQueryRecord | ||
Description |
Gets the audit query record corresponding to the given
| ||
Parameters | osid.type.Type | auditRecordType | an audit record type |
Return | osid.inquiry.records.AuditQueryRecord | the audit query record | |
Errors | NULL_ARGUMENT | auditRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(auditRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |