OSID Logo
OSID Specifications
offering rules package
Version 3.1.0
Interfaceosid.offering.rules.OfferingConstrainerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.offering.rules.OfferingConstrainerSearchSession
Description

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

MethodgetOfferingConstrainers
Description

Gets the OfferingConstrainerList resulting from a search.

Returnosid.offering.rules.OfferingConstrainerList the offering constrainer list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetOfferingConstrainerQueryInspector
Description

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

Returnosid.offering.rules.OfferingConstrainerQueryInspector the offering constrainer query inspector
Compliancemandatory This 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.TypeofferingConstrainerSearchRecordType an offering constrainer search record type
Returnosid.offering.rules.records.OfferingConstrainerSearchResultsRecord the offering constrainer search results record
ErrorsNULL_ARGUMENT offeringConstrainerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(offeringConstrainerSearchRecordType) is false
Compliancemandatory This method must be implemented.