OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
ordering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.ordering.ProductQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
| Description |
This is the query inspector for examining product queries. | ||
| Method | getCodeTerms | ||
| Description |
Gets the code terms. | ||
| Return | osid.search.terms.StringTerm[] | the code terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPriceScheduleIdTerms | ||
| Description |
Gets the price schedule | ||
| Return | osid.search.terms.IdTerm[] | the price schedule Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPriceScheduleTerms | ||
| Description |
Gets the price schedule terms. | ||
| Return | osid.ordering.PriceScheduleQueryInspector[] | the price schedule terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAvailabilityTerms | ||
| Description |
Gets the availability terms. | ||
| Return | osid.search.terms.CardinalRangeTerm[] | the availability terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getItemIdTerms | ||
| Description |
Gets the item | ||
| Return | osid.search.terms.IdTerm[] | the item Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getItemTerms | ||
| Description |
Gets the item terms. | ||
| Return | osid.ordering.ItemQueryInspector[] | the item terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStoreIdTerms | ||
| Description |
Gets the store | ||
| Return | osid.search.terms.IdTerm[] | the store Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStoreTerms | ||
| Description |
Gets the store terms. | ||
| Return | osid.ordering.StoreQueryInspector[] | the store terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProductQueryInspectorRecord | ||
| Description |
Gets the product query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | productRecordType | an product record type |
| Return | osid.ordering.records.ProductQueryInspectorRecord | the product query inspector record | |
| Errors | NULL_ARGUMENT | productRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(productRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |