OSID Logo
OSID Specifications
offering package
Version 3.1.0
Interfaceosid.offering.CatalogueSearchResults
Implementsosid.OsidSearchResults
Used Byosid.offering.CatalogueSearchSession
Description

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

MethodgetCatalogues
Description

Gets the catalogue list resulting from a search.

Returnosid.offering.CatalogueList the catalogue list
ErrorsILLEGAL_STATE the list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetCatalogueQueryInspector
Description

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

Returnosid.offering.CatalogueQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetCatalogueSearchResultsRecord
Description

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

Parametersosid.type.TypecatalogueSearchRecordType a catalogue search record type
Returnosid.offering.records.CatalogueSearchResultsRecord the catalogue search results record
ErrorsNULL_ARGUMENT catalogueSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(catalogueSearchRecordType) is false
Compliancemandatory This method must be implemented.