OSID Logo
OSID Specifications
cataloging rules package
Version 3.1.0
Interfaceosid.cataloging.rules.CatalogEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.cataloging.rules.CatalogEnablerSearchSession
Description

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

MethodgetCatalogEnablers
Description

Gets the CatalogEnablerList resulting from a search.

Returnosid.cataloging.rules.CatalogEnablerList the catalog enabler list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetCatalogEnablerQueryInspector
Description

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

Returnosid.cataloging.rules.CatalogEnablerQueryInspector the catalog enabler query inspector
Compliancemandatory This method must be implemented.
MethodgetCatalogEnablerSearchResultsRecord
Description

Gets the catalog enabler search results record corresponding to the given catalog enabler search record Type.This method must be used to retrieve an object implementing the requested record.

Parametersosid.type.TypecatalogEnablerSearchRecordType a catalog enabler search record type
Returnosid.cataloging.rules.records.CatalogEnablerSearchResultsRecord the catalog enabler search results record
ErrorsNULL_ARGUMENT catalogEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(catalogEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.