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

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

MethodgetOfferingConstrainerEnablers
Description

Gets the OfferingConstrainerEnablerList resulting from a search.

Returnosid.offering.rules.OfferingConstrainerEnablerListthe offering constrainer enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerEnablerQueryInspector
Description

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

Returnosid.offering.rules.OfferingConstrainerEnablerQueryInspectorthe offering constrainer enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerEnablerSearchResultsRecord
Description

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

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