OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.OfferingConstrainerSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetOfferingConstrainers
Description

Gets the OfferingConstrainerList resulting from a search.

Returnosid.offering.rules.OfferingConstrainerListthe offering constrainer list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerQueryInspector
Description

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

Returnosid.offering.rules.OfferingConstrainerQueryInspectorthe offering constrainer query inspector
CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerSearchResultsRecord
Description

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

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