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

The search interface for governing price schedule searches.

MethodsearchAmongPriceSchedules
Description

Execute this search among the given list of price schedules.

Parametersosid.id.IdListpriceScheduleIdslist of price schedules
ErrorsNULL_ARGUMENT priceScheduleIds is null
CompliancemandatoryThis method must be implemented.
MethodorderPriceScheduleResults
Description

Specify an ordering to the search results.

Parametersosid.ordering.PriceScheduleSearchOrderpriceScheduleSearchOrderprice schedule search order
ErrorsNULL_ARGUMENT priceScheduleSearchOrder is null
UNSUPPORTED priceScheduleSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPriceScheduleSearchRecord
Description

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

Parametersosid.type.TypepriceScheduleSearchRecordTypea price schedule search record type
Returnosid.ordering.records.PriceScheduleSearchRecordthe price schedule search record
ErrorsNULL_ARGUMENT priceScheduleSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(priceScheduleSearchRecordType) is false
CompliancemandatoryThis method must be implemented.