OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
offering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.offering.ResultQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidTemporalQueryInspector | |||
osid.OsidSubjugateableQueryInspector | |||
| Description |
The query inspectors provide a means of accessing the match
terms of a query. These interfaces are used to examine the
actual query terms used in a search or that may be used to
create a smart catalog. Query inspectors may be converted to
| ||
| Method | getParticipantIdTerms | ||
| Description |
Gets the participant | ||
| Return | osid.search.terms.IdTerm[] | the participant Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getParticipantTerms | ||
| Description |
Gets the participant query terms. | ||
| Return | osid.offering.ParticipantQueryInspector[] | the participant terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGradeIdTerms | ||
| Description |
Gets the grade | ||
| Return | osid.search.terms.IdTerm[] | the grade Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGradeTerms | ||
| Description |
Gets the grade query terms. | ||
| Return | osid.grading.GradeQueryInspector[] | the grade terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getValueTerms | ||
| Description |
Gets the value query terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the value terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCatalogueIdTerms | ||
| Description |
Gets the catalogue | ||
| Return | osid.search.terms.IdTerm[] | the catalogue Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCatalogueTerms | ||
| Description |
Gets the catalogue query terms. | ||
| Return | osid.offering.CatalogueQueryInspector[] | the catalogue terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResultQueryInspectorRecord | ||
| Description |
Gets the result query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | resultRecordType | an result record type |
| Return | osid.offering.records.ResultQueryInspectorRecord | the result inspector query record | |
| Errors | NULL_ARGUMENT | resultRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(resultRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |