OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.CatalogueSearch
Implementsosid.OsidSearch
Description

The search interface for governing catalogue searches.

MethodsearchAmongCatalogues
Description

Execute this search among the given list of catalogues.

Parametersosid.id.IdListcatalogueIdslist of catalogues
ErrorsNULL_ARGUMENT catalogueIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCatalogueResults
Description

Specify an ordering to the search results.

Parametersosid.offering.CatalogueSearchOrdercatalogueSearchOrdercatalogue search order
ErrorsNULL_ARGUMENT catalogueSearchOrder is null
UNSUPPORTED catalogueSearchOrder is not of this service
CompliancemandatoryThis 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.TypecatalogueSearchRecordTypea catalogue search record type
Returnosid.offering.records.CatalogueSearchRecordthe catalogue search record
ErrorsNULL_ARGUMENT catalogueSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(catalogueSearchRecordType) is false
CompliancemandatoryThis method must be implemented.