OSID Specifications
offering package
Version 3.1.0
offering package
Version 3.1.0
| Interface | osid.offering.ParticipantQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Used By | osid.offering.CatalogueQueryInspector | ||
osid.offering.ParticipantSearchResults | |||
osid.offering.ParticipantSmartCatalogueSession | |||
osid.offering.ResultQueryInspector | |||
| 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 | getOfferingIdTerms | ||
| Description |
Gets the offering | ||
| Return | osid.search.terms.IdTerm[] | the offering Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfferingTerms | ||
| Description |
Gets the offering query terms. | ||
| Return | osid.offering.OfferingQueryInspector[] | the offering terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the resource Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceTerms | ||
| Description |
Gets the resource query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the resource terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTimePeriodIdTerms | ||
| Description |
Gets the time period | ||
| Return | osid.search.terms.IdTerm[] | the time period Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTimePeriodTerms | ||
| Description |
Gets the time period query terms. | ||
| Return | osid.calendaring.TimePeriodQueryInspector[] | the time period query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResultOptionIdTerms | ||
| Description |
Gets the grade system | ||
| Return | osid.search.terms.IdTerm[] | the grade system Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResultOptionTerms | ||
| Description |
Gets the grade system query terms. | ||
| Return | osid.grading.GradeSystemQueryInspector[] | the grade system 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 | getParticipantQueryInspectorRecord | ||
| Description |
Gets the participant query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | participantRecordType | a participant record type |
| Return | osid.offering.records.ParticipantQueryInspectorRecord | the participant inspector query record | |
| Errors | NULL_ARGUMENT | participantRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(participantRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |