OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.InventorySearch
Implementsosid.OsidSearch
Description

The search interface for governing inventory searches.

MethodsearchAmongInventories
Description

Execute this search among the given list of inventories.

Parametersosid.id.IdListinventoryIdslist of inventories
ErrorsNULL_ARGUMENT inventoryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderInventoryResults
Description

Specify an ordering to the search results.

Parametersosid.inventory.InventorySearchOrderinventorySearchOrderinventory search order
ErrorsNULL_ARGUMENT inventorySearchOrder is null
UNSUPPORTED inventorySearchOrder is not of this service
CompliancemandatoryThis 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.TypeinventorySearchRecordTypea inventory search record type
Returnosid.inventory.records.InventorySearchRecordthe inventory search record
ErrorsNULL_ARGUMENT inventorySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inventorySearchRecordType) is false
CompliancemandatoryThis method must be implemented.