OSID Logo
OSID Specifications
cataloging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.cataloging.CatalogSearch
Implementsosid.OsidSearch
Description

The search interface for governing the search query for Catalogs.

MethodsearchAmongCatalogs
Description

Execute this search among the given list of catalogs.

Parametersosid.id.IdListcatalogIdslist of catalogs
ErrorsNULL_ARGUMENT catalogIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCatalogResults
Description

Specify an ordering to the search results.

Parametersosid.cataloging.CatalogSearchOrdercatalogSearchOrdercatalog search order
ErrorsNULL_ARGUMENT catalogSearchOrder is null
UNSUPPORTED catalogSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCatalogSearchRecord
Description

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

Parametersosid.type.TypecatalogSearchRecordTypea catalog search record type
Returnosid.cataloging.records.CatalogSearchRecordthe catalog search record
ErrorsNULL_ARGUMENT catalogSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(catalogSearchRecordType) is false
CompliancemandatoryThis method must be implemented.