OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.ProductSearch
Implementsosid.OsidSearch
Used Byosid.ordering.ProductSearchSession
Description

The search interface for governing product searches.

MethodsearchAmongProducts
Description

Execute this search among the given list of products.

Parametersosid.id.IdListproductIds list of products
ErrorsNULL_ARGUMENT productIds is null
Compliancemandatory This method must be implemented.
MethodorderProductResults
Description

Specify an ordering to the search results.

Parametersosid.ordering.ProductSearchOrderproductSearchOrder product search order
ErrorsNULL_ARGUMENT productSearchOrder is null
UNSUPPORTED productSearchOrder is not of this service
Compliancemandatory This 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.TypeproductSearchRecordType a product search record type
Returnosid.ordering.records.ProductSearchRecord the product search record
ErrorsNULL_ARGUMENT productSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(productSearchRecordType) is false
Compliancemandatory This method must be implemented.