OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.CanonicalUnitProcessorEnablerSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetCanonicalUnitProcessorEnablers
Description

Gets the CanonicalUnitProcessorEnablerList resulting from a search.

Returnosid.offering.rules.CanonicalUnitProcessorEnablerListthe canonical unit processor enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitProcessorEnablerQueryInspector
Description

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

Returnosid.offering.rules.CanonicalUnitProcessorEnablerQueryInspectorthe canonical unit processor enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitProcessorEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypecanonicalUnitProcessorEnablerSearchRecordTypea canonical unit processor enabler search record type
Returnosid.offering.rules.records.CanonicalUnitProcessorEnablerSearchResultsRecordthe canonical unit processor enabler search results record
ErrorsNULL_ARGUMENT canonicalUnitProcessorEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(canonicalUnitProcessorEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.