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

An interface for specifying the ordering of search results.

MethodorderByStock
Description

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

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

Tests if a StockSearchOrder is available.

Returnboolean true if a stock search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetStockSearchOrder
Description

Gets the search order for a stock.

Returnosid.inventory.StockSearchOrderthe stock search order
ErrorsUNIMPLEMENTED supportsStockSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsStockSearchOrder() is true.
MethodorderByDate
Description

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

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

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

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

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

Parametersosid.type.TypeinventoryRecordTypean inventory record type
Returnosid.inventory.records.InventorySearchOrderRecordthe inventory search order record
ErrorsNULL_ARGUMENT inventoryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inventoryRecordType) is false
CompliancemandatoryThis method must be implemented.