OSID Logo
OSID Specifications
inventory package
Version 3.1.0
Interfaceosid.inventory.ItemQueryInspector
Implementsosid.OsidObjectQueryInspector
Used Byosid.inventory.ItemQueryInspector
osid.inventory.ItemSearchResults
osid.inventory.ItemSmartWarehouseSession
osid.inventory.WarehouseQueryInspector
osid.inventory.shipment.EntryQueryInspector
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.

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.
MethodgetPropertyTagTerms
Description

Gets the property tag query terms.

Returnosid.search.terms.StringTerm[] the property tag query terms
Compliancemandatory This method must be implemented.
MethodgetSerialNumberTerms
Description

Gets the serial number query terms.

Returnosid.search.terms.StringTerm[] the serial number query terms
Compliancemandatory This method must be implemented.
MethodgetLocationDescriptionTerms
Description

Gets the location description query terms.

Returnosid.search.terms.StringTerm[] the location description query terms
Compliancemandatory This method must be implemented.
MethodgetLocationIdTerms
Description

Gets the location Id query terms.

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

Gets the location query terms.

Returnosid.mapping.LocationQueryInspector[] the location query terms
Compliancemandatory This method must be implemented.
MethodgetItemIdTerms
Description

Gets the item Id query terms.

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

Gets the item query terms.

Returnosid.inventory.ItemQueryInspector[] the item 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.
MethodgetItemQueryInspectorRecord
Description

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

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