OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
inventory package
Version 3.0.0
Release Candidate Preview
| Interface | osid.inventory.ModelQueryInspector | ||
|---|---|---|---|
| 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 | getManufacturerIdTerms | ||
| Description |
Gets the manufacturer | ||
| Return | osid.search.terms.IdTerm[] | the resource Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getManufacturerTerms | ||
| Description |
Gets the manufacturer query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the resource query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getArchetypeTerms | ||
| Description |
Gets the archetype query terms. | ||
| Return | osid.search.terms.StringTerm[] | the archetype query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getNumberTerms | ||
| Description |
Gets the model number query terms. | ||
| Return | osid.search.terms.StringTerm[] | the model number 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 | getModelQueryInspectorRecord | ||
| Description |
Gets the model query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | modelRecordType | a model record type |
| Return | osid.inventory.records.ModelQueryInspectorRecord | the model query inspector record | |
| Errors | NULL_ARGUMENT | modelRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(modelRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |