OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
inventory package
Version 3.0.0
Release Candidate Preview
| Interface | osid.inventory.WarehouseQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| 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 | getItemIdTerms | ||
| Description |
Gets the item | ||
| Return | osid.search.terms.IdTerm[] | the item Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getItemTerms | ||
| Description |
Gets the item query terms. | ||
| Return | osid.inventory.ItemQueryInspector[] | the item query terms | |
| Compliance | mandatory | This method must be implemented. | |
| 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 | getModelIdTerms | ||
| Description |
Gets the model | ||
| Return | osid.search.terms.IdTerm[] | the model Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getModelTerms | ||
| Description |
Gets the model query terms. | ||
| Return | osid.inventory.ModelQueryInspector[] | the model query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInventoryIdTerms | ||
| Description |
Gets the inventory | ||
| Return | osid.search.terms.IdTerm[] | the inventory Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInventoryTerms | ||
| Description |
Gets the inventory query terms. | ||
| Return | osid.inventory.InventoryQueryInspector[] | the inventory query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorWarehouseIdTerms | ||
| Description |
Gets the ancestor warehouse | ||
| Return | osid.search.terms.IdTerm[] | the ancestor warehouse Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorWarehouseTerms | ||
| Description |
Gets the ancestor warehouse query terms. | ||
| Return | osid.inventory.WarehouseQueryInspector[] | the ancestor warehouse terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantWarehouseIdTerms | ||
| Description |
Gets the descendant warehouse | ||
| Return | osid.search.terms.IdTerm[] | the descendant warehouse Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantWarehouseTerms | ||
| Description |
Gets the descendant warehouse query terms. | ||
| Return | osid.inventory.WarehouseQueryInspector[] | the descendant warehouse terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWarehouseQueryInspectorRecord | ||
| Description |
Gets the warehouse query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | warehouseRecordType | a warehouse record type |
| Return | osid.inventory.records.WarehouseQueryInspectorRecord | the warehouse query inspector record | |
| Errors | NULL_ARGUMENT | warehouseRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(warehouseRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |