OSID Logo
OSID Specifications
offering package
Version 3.1.0
Interfaceosid.offering.OfferingSearchResults
Implementsosid.OsidSearchResults
Used Byosid.offering.OfferingSearchSession
Description

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

MethodgetOfferings
Description

Gets the offering list resulting from a search.

Returnosid.offering.OfferingList the offering list
ErrorsILLEGAL_STATE the list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetOfferingQueryInspector
Description

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

Returnosid.offering.OfferingQueryInspector the query inspector
Compliancemandatory This 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.TypeofferingSearchRecordType an offering search record type
Returnosid.offering.records.OfferingSearchResultsRecord the offering search results record
ErrorsNULL_ARGUMENT offeringSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(offeringSearchRecordType) is false
Compliancemandatory This method must be implemented.