OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.ItemSearchOrder
Implementsosid.OsidObjectSearchOrder
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.
MethodorderByPropertyTag
Description

Specifies a preference for ordering the result set by the property tag.

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

Specifies a preference for ordering the result set by the serial number.

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.
MethodorderByLocation
Description

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

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

Tests if a LocationSearchOrder is available.

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

Gets the location order for a stock.

Returnosid.mapping.LocationSearchOrderthe location search order
ErrorsUNIMPLEMENTED supportsLocationSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsLocationSearchOrder() is true.
MethodorderByItem
Description

Specifies a preference for ordering the result set by the containing item.

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

Tests if an ItemSearchOrder is available.

Returnboolean true if an item search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetItemSearchOrder
Description

Gets the item order for a stock.

Returnosid.inventory.ItemSearchOrderthe location search order
ErrorsUNIMPLEMENTED supportsItemSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsItemSearchOrder() is true.
MethodgetItemSearchOrderRecord
Description

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

Parametersosid.type.TypeitemRecordTypean item record type
Returnosid.inventory.records.ItemSearchOrderRecordthe item search order record
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
CompliancemandatoryThis method must be implemented.