OSID Logo
OSID Specifications
ordering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.rules.PriceEnablerSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetPriceEnablers
Description

Gets the PriceEnablerList resulting from a search.

Returnosid.ordering.rules.PriceEnablerListthe price enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetPriceEnablerQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.ordering.rules.PriceEnablerQueryInspectorthe price enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetPriceEnablerSearchResultsRecord
Description

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

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