OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
offering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.offering.CanonicalUnitQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidOperableQueryInspector | |||
| 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 | getTitleTerms | ||
| Description |
Gets the title query terms. | ||
| Return | osid.search.terms.StringTerm[] | the title terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCodeTerms | ||
| Description |
Gets the code query terms. | ||
| Return | osid.search.terms.StringTerm[] | the code terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfferedCyclicTimePeriodIdTerms | ||
| Description |
Gets the offered cyclic time period | ||
| Return | osid.search.terms.IdTerm[] | the cyclic time period Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfferedCyclicTimePeriodTerms | ||
| Description |
Gets the offered cyclic time period query terms. | ||
| Return | osid.calendaring.cycle.CyclicTimePeriodQueryInspector[] | the cyclic time period 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 | getSponsorIdTerms | ||
| Description |
Gets the sponsor | ||
| Return | osid.search.terms.IdTerm[] | the sponsor Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSponsorTerms | ||
| Description |
Gets the sponsor query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the sponsor query 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 | getCanonicalUnitQueryInspectorRecord | ||
| Description |
Gets the canonical unit query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | canonicalUnitRecordType | a canonical unit record type |
| Return | osid.offering.records.CanonicalUnitQueryInspectorRecord | the canonical unit inspector query record | |
| Errors | NULL_ARGUMENT | canonicalUnitRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(canonicalUnitRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |