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

The search interface for governing catalog enabler searches.

MethodsearchAmongCatalogEnablers
Description

Execute this search among the given list of catalog enablers.

Parametersosid.id.IdListcatalogEnablerIdslist of catalog enablers
ErrorsNULL_ARGUMENT catalogEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCatalogEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.cataloging.rules.CatalogEnablerSearchOrdercatalogEnablerSearchOrdercatalog enabler search order
ErrorsNULL_ARGUMENT catalogEnablerSearchOrder is null
UNSUPPORTED catalogEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCatalogEnablerSearchRecord
Description

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

Parametersosid.type.TypecatalogEnablerSearchRecordTypea catalog enabler search record type
Returnosid.cataloging.rules.records.CatalogEnablerSearchRecordthe catalog enabler search record
ErrorsNULL_ARGUMENT catalogEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(catalogEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.