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

The search interface for governing price enabler searches.

MethodsearchAmongPriceEnablers
Description

Execute this search among the given list of price enablers.

Parametersosid.id.IdListpriceEnablerIdslist of price enablers
ErrorsNULL_ARGUMENT priceEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderPriceEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.ordering.rules.PriceEnablerSearchOrderpriceEnablerSearchOrderprice enabler search order
ErrorsNULL_ARGUMENT priceEnablerSearchOrder is null
UNSUPPORTED priceEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPriceEnablerSearchRecord
Description

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

Parametersosid.type.TypepriceEnablerSearchRecordTypea price enabler search record type
Returnosid.ordering.rules.records.PriceEnablerSearchRecordthe price enabler search record
ErrorsNULL_ARGUMENT priceEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(priceEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.