OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.StockSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidFederateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderBySKU
Description

Specifies a preference for ordering the result set by the sku.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByLocationDescription
Description

Specifies a preference for ordering the result set by the location description.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetStockSearchOrderRecord
Description

Gets the stock search order record corresponding to the given stock record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypestockRecordTypea stock record type
Returnosid.inventory.records.StockSearchOrderRecordthe stock search order record
ErrorsNULL_ARGUMENT stockRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stockRecordType) is false
CompliancemandatoryThis method must be implemented.