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

The search interface for governing stock searches.

MethodsearchAmongStocks
Description

Execute this search among the given list of stocks.

Parametersosid.id.IdListstockIdslist of stocks
ErrorsNULL_ARGUMENT stockIds is null
CompliancemandatoryThis method must be implemented.
MethodorderStockResults
Description

Specify an ordering to the search results.

Parametersosid.inventory.StockSearchOrderstockSearchOrderstock search order
ErrorsNULL_ARGUMENT stockSearchOrder is null
UNSUPPORTED stockSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStockSearchRecord
Description

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

Parametersosid.type.TypestockSearchRecordTypea stock search record type
Returnosid.inventory.records.StockSearchRecordthe stock search record
ErrorsNULL_ARGUMENT stockSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stockSearchRecordType) is false
CompliancemandatoryThis method must be implemented.