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

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

MethodgetCatalogues
Description

Gets the catalogue list resulting from a search.

Returnosid.offering.CatalogueListthe catalogue list
ErrorsILLEGAL_STATEthe list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCatalogueQueryInspector
Description

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

Returnosid.offering.CatalogueQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypecatalogueSearchRecordTypea catalogue search record type
Returnosid.offering.records.CatalogueSearchResultsRecordthe catalogue search results record
ErrorsNULL_ARGUMENT catalogueSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(catalogueSearchRecordType) is false
CompliancemandatoryThis method must be implemented.