OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.ProductSearchOrder
Implementsosid.OsidObjectSearchOrder
Used Byosid.billing.ItemSearchOrder
osid.ordering.ItemSearchOrder
osid.ordering.ProductSearchSession
osid.ordering.ProductSmartStoreSession
Description

An interface for specifying the ordering of search results.

MethodorderByCode
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByAvailability
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodgetProductSearchOrderRecord
Description

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

Parametersosid.type.TypeproductRecordType a product record type
Returnosid.ordering.records.ProductSearchOrderRecord the product search order record
ErrorsNULL_ARGUMENT productRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(productRecordType) is false
Compliancemandatory This method must be implemented.