OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.OfferingConstrainerSearch
Implementsosid.OsidSearch
Description

The search interface for governing offering constrainer searches.

MethodsearchAmongOfferingConstrainers
Description

Execute this search among the given list of offering constrainers.

Parametersosid.id.IdListofferingConstrainerIdslist of offering constrainers
ErrorsNULL_ARGUMENT offeringConstrainerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderOfferingConstrainerResults
Description

Specify an ordering to the search results.

Parametersosid.offering.rules.OfferingConstrainerSearchOrderofferingConstrainerSearchOrderoffering constrainer search order
ErrorsNULL_ARGUMENT offeringConstrainerSearchOrder is null
UNSUPPORTED offeringConstrainerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerSearchRecord
Description

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

Parametersosid.type.TypeofferingConstrainerSearchRecordTypean offering constrainer search record type
Returnosid.offering.rules.records.OfferingConstrainerSearchRecordthe offering constrainer search record
ErrorsNULL_ARGUMENT offeringConstrainerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(offeringConstrainerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.