OSID Logo
OSID Specifications
inventory package
Version 3.1.0
Interfaceosid.inventory.StockSearch
Implementsosid.OsidSearch
Used Byosid.inventory.StockSearchSession
Description

The search interface for governing stock searches.

MethodsearchAmongStocks
Description

Execute this search among the given list of stocks.

Parametersosid.id.IdListstockIds list of stocks
ErrorsNULL_ARGUMENT stockIds is null
Compliancemandatory This method must be implemented.
MethodorderStockResults
Description

Specify an ordering to the search results.

Parametersosid.inventory.StockSearchOrderstockSearchOrder stock search order
ErrorsNULL_ARGUMENT stockSearchOrder is null
UNSUPPORTED stockSearchOrder is not of this service
Compliancemandatory This 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.TypestockSearchRecordType a stock search record type
Returnosid.inventory.records.StockSearchRecord the stock search record
ErrorsNULL_ARGUMENT stockSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(stockSearchRecordType) is false
Compliancemandatory This method must be implemented.