OSID Logo
OSID Specifications
inventory package
Version 3.1.0
Interfaceosid.inventory.InventoryQueryInspector
Implementsosid.OsidObjectQueryInspector
osid.OsidSubjugateableQueryInspector
Used Byosid.inventory.InventorySearchResults
osid.inventory.InventorySmartWarehouseSession
osid.inventory.WarehouseQueryInspector
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 OsidQuery interfaces for reuse or modification in the search sessions.

Like all OsidQueryInspectors, InventoryQueryInspector is stateful and must not be accessed by multiple processing threads.

MethodgetStockIdTerms
Description

Gets the stock Id query terms.

Returnosid.search.terms.IdTerm[] the stock Id query terms
Compliancemandatory This method must be implemented.
MethodgetStockTerms
Description

Gets the stock query terms.

Returnosid.inventory.StockQueryInspector[] the stock query terms
Compliancemandatory This method must be implemented.
MethodgetDateTerms
Description

Gets the date query terms.

Returnosid.search.terms.DateTimeTerm[] the date query terms
Compliancemandatory This method must be implemented.
MethodgetDateInclusiveTerms
Description

Gets the date query terms.

Returnosid.search.terms.DateTimeRangeTerm[] the date range query terms
Compliancemandatory This method must be implemented.
MethodgetQuantityTerms
Description

Gets the quantity terms.

Returnosid.search.terms.DecimalRangeTerm[] the quantity query terms
Compliancemandatory This method must be implemented.
MethodgetWarehouseIdTerms
Description

Gets the warehouse Id query terms.

Returnosid.search.terms.IdTerm[] the warehouse Id query terms
Compliancemandatory This method must be implemented.
MethodgetWarehouseTerms
Description

Gets the warehouse query terms.

Returnosid.inventory.WarehouseQueryInspector[] the warehouse query terms
Compliancemandatory This method must be implemented.
MethodgetInventoryQueryInspectorRecord
Description

Gets the inventory query inspector record corresponding to the given Inventory record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeinventoryRecordType an inventory record type
Returnosid.inventory.records.InventoryQueryInspectorRecord the inventory query inspector record
ErrorsNULL_ARGUMENT inventoryRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(inventoryRecordType) is false
Compliancemandatory This method must be implemented.