OSID Logo
OSID Specifications
cataloging package
Version 3.1.0
Interfaceosid.cataloging.CatalogSearchResults
Implementsosid.OsidSearchResults
Used Byosid.cataloging.CatalogSearchSession
Description

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

MethodgetCatalogs
Description

Gets the catalog list resulting from the search.

Returnosid.cataloging.CatalogList the catalogs list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetCatalogQueryInspector
Description

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

Returnosid.cataloging.CatalogQueryInspector the catalog query inspector
Compliancemandatory This 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.TypecatalogSearchRecordType a catalog search record type
Returnosid.cataloging.records.CatalogSearchResultsRecord the catalog search results record
ErrorsNULL_ARGUMENT catalogSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(catalogSearchRecordType) is false
Compliancemandatory This method must be implemented.