OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
inquiry package
Version 3.0.0
Release Candidate Preview
| Interface | osid.inquiry.InquiryQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRuleQueryInspector | ||
osid.OsidSubjugateableQueryInspector | |||
| Description |
This is the query inspector for examining inquiry queries. | ||
| Method | getAuditIdTerms | ||
| Description |
Gets the audit | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditTerms | ||
| Description |
Gets the audit query terms. | ||
| Return | osid.inquiry.AuditQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQuestionTerms | ||
| Description |
Gets the question query terms. | ||
| Return | osid.search.terms.StringTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRequiredTerms | ||
| Description |
Gets the required query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAffirmationRequiredTerms | ||
| Description |
Gets the affirmation required query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getNeedsOneResponseTerms | ||
| Description |
Gets the needs one response query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquestIdTerms | ||
| Description |
Gets the inquest | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquestTerms | ||
| Description |
Gets the inquest query terms. | ||
| Return | osid.inquiry.InquestQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquiryQueryInspectorRecord | ||
| Description |
Gets the inquiry query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | inquiryRecordType | an inquiry record type |
| Return | osid.inquiry.records.InquiryQueryInspectorRecord | the inquiry query inspector record | |
| Errors | NULL_ARGUMENT | inquiryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(inquiryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |