OSID Logo
OSID Specifications
cataloging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.cataloging.CatalogSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetCatalogs
Description

Gets the catalog list resulting from the search.

Returnosid.cataloging.CatalogListthe catalogs list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCatalogQueryInspector
Description

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

Returnosid.cataloging.CatalogQueryInspectorthe catalog query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCatalogSearchResultsRecord
Description

Gets the catalog search results 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.CatalogSearchResultsRecordthe catalog search results record
ErrorsNULL_ARGUMENT catalogSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(catalogSearchRecordType) is false
CompliancemandatoryThis method must be implemented.