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

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

MethodgetOfferings
Description

Gets the offering list resulting from a search.

Returnosid.offering.OfferingListthe offering list
ErrorsILLEGAL_STATEthe list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetOfferingQueryInspector
Description

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

Returnosid.offering.OfferingQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetOfferingSearchResultsRecord
Description

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

Parametersosid.type.TypeofferingSearchRecordTypean offering search record type
Returnosid.offering.records.OfferingSearchResultsRecordthe offering search results record
ErrorsNULL_ARGUMENT offeringSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(offeringSearchRecordType) is false
CompliancemandatoryThis method must be implemented.