OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
inventory package
Version 3.0.0
Release Candidate Preview
| Interface | osid.inventory.ItemQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
| 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 | getPropertyTagTerms | ||
| Description |
Gets the property tag query terms. | ||
| Return | osid.search.terms.StringTerm[] | the property tag query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSerialNumberTerms | ||
| Description |
Gets the serial number query terms. | ||
| Return | osid.search.terms.StringTerm[] | the serial number query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLocationDescriptionTerms | ||
| Description |
Gets the location description query terms. | ||
| Return | osid.search.terms.StringTerm[] | the location description query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLocationIdTerms | ||
| Description |
Gets the location | ||
| Return | osid.search.terms.IdTerm[] | the location Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLocationTerms | ||
| Description |
Gets the location query terms. | ||
| Return | osid.mapping.LocationQueryInspector[] | the location query terms | |
| Compliance | mandatory | This method must be implemented. | |
| 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 | 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 | getItemQueryInspectorRecord | ||
| Description |
Gets the item query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | itemRecordType | an item record type |
| Return | osid.inventory.records.ItemQueryInspectorRecord | the item query inspector record | |
| Errors | NULL_ARGUMENT | itemRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(itemRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |