Interface | osid.offering.OfferingQueryInspector | ||
---|---|---|---|
Implements | osid.OsidRelationshipQueryInspector | ||
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 | getCanonicalUnitIdTerms | ||
Description |
Gets the canonical unit | ||
Return | osid.search.terms.IdTerm[] | the canonical unit Id query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getCanonicalUnitTerms | ||
Description |
Gets the canonical unit query terms. | ||
Return | osid.offering.CanonicalUnitQueryInspector[] | the canonical unit query 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 | 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 | 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 | getOfferingQueryInspectorRecord | ||
Description |
Gets the offering query inspector record corresponding
to the given | ||
Parameters | osid.type.Type | offeringRecordType | an offering record type |
Return | osid.offering.records.OfferingQueryInspectorRecord | the offering inspector query record | |
Errors | NULL_ARGUMENT | offeringRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(offeringRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |