OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.ProductSearch
Implementsosid.OsidSearch
Description

The search interface for governing product searches.

MethodsearchAmongProducts
Description

Execute this search among the given list of products.

Parametersosid.id.IdListproductIdslist of products
ErrorsNULL_ARGUMENT productIds is null
CompliancemandatoryThis method must be implemented.
MethodorderProductResults
Description

Specify an ordering to the search results.

Parametersosid.ordering.ProductSearchOrderproductSearchOrderproduct search order
ErrorsNULL_ARGUMENT productSearchOrder is null
UNSUPPORTED productSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProductSearchRecord
Description

Gets the product search record corresponding to the given product search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeproductSearchRecordTypean product search record type
Returnosid.ordering.records.ProductSearchRecordthe product search record
ErrorsNULL_ARGUMENT productSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(productSearchRecordType) is false
CompliancemandatoryThis method must be implemented.