Interface | osid.inquiry.rules.InquiryEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching inquiry enablers. Each
method match specifies an | ||
Method | matchRuledAuditId | ||
Description |
Matches enablers mapped to the audit. | ||
Parameters | osid.id.Id | auditId | the audit Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | auditId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledAuditIdTerms | ||
Description |
Clears the audit | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledAuditQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an audit query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledAuditQuery | ||
Description |
Gets the query for an audit. Multiple retrievals
produce a nested | ||
Return | osid.inquiry.AuditQuery | the audit query | |
Errors | UNIMPLEMENTED | supportsRuledAuditQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledAuditQuery()
is true. | |
Method | matchAnyRuledAudit | ||
Description |
Matches enablers mapped to any audit. | ||
Parameters | boolean | match | true for enablers mapped to any audit, false
to match enablers mapped to no audits |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledAuditTerms | ||
Description |
Clears the audit query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchInquestId | ||
Description |
Matches enablers mapped to 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 | getInquiryEnablerQueryRecord | ||
Description |
Gets the inquiry enabler query record corresponding to
the given | ||
Parameters | osid.type.Type | inquiryEnablerRecordType | an inquiry enabler record type |
Return | osid.inquiry.rules.records.InquiryEnablerQueryRecord | the inquiry enabler query record | |
Errors | NULL_ARGUMENT | inquiryEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(inquiryEnablerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |