OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.ItemQuery
Implementsosid.OsidObjectQuery
Description

This is the query for searching items. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchStockId
Description

Sets the stock Id for this query.

Parametersosid.id.IdstockIdthe stock Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT stockId is null
CompliancemandatoryThis method must be implemented.
MethodclearStockIdTerms
Description

Clears the stock Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsStockQuery
Description

Tests if a StockQuery is available.

Returnboolean true if a stock query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetStockQuery
Description

Gets the query for a stocjk. Multiple retrievals produce a nested OR term.

Returnosid.inventory.StockQuerythe stock query
ErrorsUNIMPLEMENTED supportsStockQuery() is false
ComplianceoptionalThis method must be implemented if supportsStockQuery() is true.
MethodmatchAnyStock
Description

Matches items that have any stock.

Parametersbooleanmatch true to match items with any stock, false to match items with no stock
CompliancemandatoryThis method must be implemented.
MethodclearStockTerms
Description

Clears the stock terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPropertyTag
Description

Matches a property identification number.

Parametersstringpropertya property number
osid.type.TypestringMatchTypea string match type
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT property or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyPropertyTag
Description

Matches items that have any property tag.

Parametersbooleanmatch true to match items with any property tag, false to match items with no property tag
CompliancemandatoryThis method must be implemented.
MethodclearPropertyTagTerms
Description

Clears the property tag terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSerialNumber
Description

Matches a serial number.

Parametersstringseriala serial number
osid.type.TypestringMatchTypea string match type
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT serial or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnySerialNumber
Description

Matches items that have any serial number.

Parametersbooleanmatch true to match items with any serial number, false to match items with no serial number
CompliancemandatoryThis method must be implemented.
MethodclearSerialNumberTerms
Description

Clears the serial number terms.

CompliancemandatoryThis method must be implemented.
MethodmatchLocationDescription
Description

Matches a location description.

Parametersstringlocationa location string
osid.type.TypestringMatchTypea string match type
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT location or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyLocationDescription
Description

Matches items that have any location description.

Parametersbooleanmatch true to match items with any location string, false to match items with no location string
CompliancemandatoryThis method must be implemented.
MethodclearLocationDescriptionTerms
Description

Clears the location description terms.

CompliancemandatoryThis method must be implemented.
MethodmatchLocationId
Description

Sets the location Id for this query.

Parametersosid.id.IdlocationIdthe location Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT locationId is null
CompliancemandatoryThis method must be implemented.
MethodclearLocationIdTerms
Description

Clears the location Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsLocationQuery
Description

Tests if a LocationQuery is available.

Returnboolean true if a location query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLocationQuery
Description

Gets the query for a location. Multiple retrievals produce a nested OR term.

Returnosid.mapping.LocationQuerythe location query
ErrorsUNIMPLEMENTED supportsLocationQuery() is false
ComplianceoptionalThis method must be implemented if supportsLocationQuery() is true.
MethodmatchAnyLocation
Description

Matches items that have any location.

Parametersbooleanmatch true to match items with any location, false to match items with no location
CompliancemandatoryThis method must be implemented.
MethodclearLocationTerms
Description

Clears the location terms.

CompliancemandatoryThis method must be implemented.
MethodmatchItemId
Description

Sets the item Id for this query to match items part of the given item.

Parametersosid.id.IditemIdthe item Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT itemId is null
CompliancemandatoryThis method must be implemented.
MethodclearItemIdTerms
Description

Clears the item Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsItemQuery
Description

Tests if an ItemQuery is available.

Returnboolean true if a item query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetItemQuery
Description

Gets the query for an item. Multiple retrievals produce a nested OR term.

Returnosid.inventory.ItemQuerythe item query
ErrorsUNIMPLEMENTED supportsItemQuery() is false
ComplianceoptionalThis method must be implemented if supportsItemQuery() is true.
MethodmatchAnyItem
Description

Matches items that have any item.

Parametersbooleanmatch true to match items part of any item, false to match items psrt of no item
CompliancemandatoryThis method must be implemented.
MethodclearItemTerms
Description

Clears the item terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWarehouseId
Description

Sets the warehouse Id for this query to match items assigned to warehouses.

Parametersosid.id.IdwarehouseIdthe warehouse Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT warehouseId is null
CompliancemandatoryThis method must be implemented.
MethodclearWarehouseIdTerms
Description

Clears the warehouse Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsWarehouseQuery
Description

Tests if a WarehouseQuery is available.

Returnboolean true if a warehouse query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetWarehouseQuery
Description

Gets the query for a warehouse. Multiple retrievals produce a nested OR term.

Returnosid.inventory.WarehouseQuerythe warehouse query
ErrorsUNIMPLEMENTED supportsWarehouseQuery() is false
ComplianceoptionalThis method must be implemented if supportsWarehouseQuery() is true.
MethodclearWarehouseTerms
Description

Clears the warehouse terms.

CompliancemandatoryThis method must be implemented.
MethodgetItemQueryRecord
Description

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

Parametersosid.type.TypeitemRecordTypean item record type
Returnosid.inventory.records.ItemQueryRecordthe item query record
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
CompliancemandatoryThis method must be implemented.