OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
inquiry package
Version 3.0.0
Release Candidate Preview
| Interface | osid.inquiry.InquestQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining inquest queries. | ||
| Method | getInquiryIdTerms | ||
| Description |
Gets the inquiry | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquiryTerms | ||
| Description |
Gets the inquiry query terms. | ||
| Return | osid.inquiry.InquiryQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| 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 | getResponseIdTerms | ||
| Description |
Gets the response | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResponseTerms | ||
| Description |
Gets the response query terms. | ||
| Return | osid.inquiry.ResponseQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorInquestIdTerms | ||
| Description |
Gets the ancestor inquest | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorInquestTerms | ||
| Description |
Gets the ancestor inquest query terms. | ||
| Return | osid.inquiry.InquestQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantInquestIdTerms | ||
| Description |
Gets the descendant inquest | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantInquestTerms | ||
| Description |
Gets the descendant inquest query terms. | ||
| Return | osid.inquiry.InquestQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquestQueryInspectorRecord | ||
| Description |
Gets the inquest query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | inquestRecordType | an inquest record type |
| Return | osid.inquiry.records.InquestQueryInspectorRecord | the inquest query inspector record | |
| Errors | NULL_ARGUMENT | inquestRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(inquestRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |