| Interface | osid.inventory.InventoryQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidSubjugateableQueryInspector | |||
| 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 | getStockIdTerms | ||
| Description |
Gets the stock | ||
| Return | osid.search.terms.IdTerm[] | the stock Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStockTerms | ||
| Description |
Gets the stock query terms. | ||
| Return | osid.inventory.StockQueryInspector[] | the stock query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDateTerms | ||
| Description |
Gets the date query terms. | ||
| Return | osid.search.terms.DateTimeTerm[] | the date query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDateInclusiveTerms | ||
| Description |
Gets the date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the date range query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQuantityTerms | ||
| Description |
Gets the quantity terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the quantity query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWarehouseIdTerms | ||
| Description |
Gets the warehouse | ||
| Return | osid.search.terms.IdTerm[] | the warehouse Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWarehouseTerms | ||
| Description |
Gets the warehouse query terms. | ||
| Return | osid.inventory.WarehouseQueryInspector[] | the warehouse query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInventoryQueryInspectorRecord | ||
| Description |
Gets the inventory query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | inventoryRecordType | an inventory record type |
| Return | osid.inventory.records.InventoryQueryInspectorRecord | the inventory query inspector record | |
| Errors | NULL_ARGUMENT | inventoryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(inventoryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |