OSID Logo
OSID Specifications
offering package
Version 3.1.0
Interfaceosid.offering.CatalogueSearch
Implementsosid.OsidSearch
Used Byosid.offering.CatalogueSearchSession
Description

The search interface for governing catalogue searches.

MethodsearchAmongCatalogues
Description

Execute this search among the given list of catalogues.

Parametersosid.id.IdListcatalogueIds list of catalogues
ErrorsNULL_ARGUMENT catalogueIds is null
Compliancemandatory This method must be implemented.
MethodorderCatalogueResults
Description

Specify an ordering to the search results.

Parametersosid.offering.CatalogueSearchOrdercatalogueSearchOrder catalogue search order
ErrorsNULL_ARGUMENT catalogueSearchOrder is null
UNSUPPORTED catalogueSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetCatalogueSearchRecord
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.CatalogueSearchRecord the catalogue search record
ErrorsNULL_ARGUMENT catalogueSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(catalogueSearchRecordType) is false
Compliancemandatory This method must be implemented.