OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.PriceSearch
Implementsosid.OsidSearch
Used Byosid.ordering.PriceSearchSession
Description

The search interface for governing price searches.

MethodsearchAmongPrices
Description

Execute this search among the given list of prices.

Parametersosid.id.IdListpriceIds list of prices
ErrorsNULL_ARGUMENT priceIds is null
Compliancemandatory This method must be implemented.
MethodorderPriceResults
Description

Specify an ordering to the search results.

Parametersosid.ordering.PriceSearchOrderpriceSearchOrder price search order
ErrorsNULL_ARGUMENT priceSearchOrder is null
UNSUPPORTED priceSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetPriceSearchRecord
Description

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

Parametersosid.type.TypepriceSearchRecordType a price search record type
Returnosid.ordering.records.PriceSearchRecord the price search record
ErrorsNULL_ARGUMENT priceSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(priceSearchRecordType) is false
Compliancemandatory This method must be implemented.