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

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

MethodgetCatalogEnablers
Description

Gets the CatalogEnablerList resulting from a search.

Returnosid.cataloging.rules.CatalogEnablerListthe catalog enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCatalogEnablerQueryInspector
Description

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

Returnosid.cataloging.rules.CatalogEnablerQueryInspectorthe catalog enabler query inspector
CompliancemandatoryThis 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.TypecatalogEnablerSearchRecordTypea catalog enabler search record type
Returnosid.cataloging.rules.records.CatalogEnablerSearchResultsRecordthe catalog enabler search results record
ErrorsNULL_ARGUMENT catalogEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(catalogEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.