OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.ProductSearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByCode
Description

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

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByAvailability
Description

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

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis 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.TypeproductRecordTypean product record type
Returnosid.ordering.records.ProductSearchOrderRecordthe product search order record
ErrorsNULL_ARGUMENT productRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(productRecordType) is false
CompliancemandatoryThis method must be implemented.