OSID Logo
OSID Specifications
inventory package
Version 3.1.0
Interfaceosid.inventory.InventorySearch
Implementsosid.OsidSearch
Used Byosid.inventory.InventorySearchSession
Description

The search interface for governing inventory searches.

MethodsearchAmongInventories
Description

Execute this search among the given list of inventories.

Parametersosid.id.IdListinventoryIds list of inventories
ErrorsNULL_ARGUMENT inventoryIds is null
Compliancemandatory This method must be implemented.
MethodorderInventoryResults
Description

Specify an ordering to the search results.

Parametersosid.inventory.InventorySearchOrderinventorySearchOrder inventory search order
ErrorsNULL_ARGUMENT inventorySearchOrder is null
UNSUPPORTED inventorySearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetInventorySearchRecord
Description

Gets the inventory search record corresponding to the given inventory search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeinventorySearchRecordType an inventory search record type
Returnosid.inventory.records.InventorySearchRecord the inventory search record
ErrorsNULL_ARGUMENT inventorySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(inventorySearchRecordType) is false
Compliancemandatory This method must be implemented.