OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
ordering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.ordering.StoreQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining store queries. | ||
| Method | getOrderIdTerms | ||
| Description |
Gets the order | ||
| Return | osid.search.terms.IdTerm[] | the order Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOrderTerms | ||
| Description |
Gets the order terms. | ||
| Return | osid.ordering.OrderQueryInspector[] | the order terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProductIdTerms | ||
| Description |
Gets the product | ||
| Return | osid.search.terms.IdTerm[] | the product Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProductTerms | ||
| Description |
Gets the product terms. | ||
| Return | osid.ordering.ProductQueryInspector[] | the product 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 | getAncestorStoreIdTerms | ||
| Description |
Gets the ancestor store | ||
| Return | osid.search.terms.IdTerm[] | the ancestor store Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorStoreTerms | ||
| Description |
Gets the ancestor store terms. | ||
| Return | osid.ordering.StoreQueryInspector[] | the ancestor store terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantStoreIdTerms | ||
| Description |
Gets the descendant store | ||
| Return | osid.search.terms.IdTerm[] | the descendant store Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantStoreTerms | ||
| Description |
Gets the descendant store terms. | ||
| Return | osid.ordering.StoreQueryInspector[] | the descendant store terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStoreQueryInspectorRecord | ||
| Description |
Gets the store query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | storeRecordType | a store record type |
| Return | osid.ordering.records.StoreQueryInspectorRecord | the store query inspector record | |
| Errors | NULL_ARGUMENT | storeRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(storeRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |