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

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

MethodgetCanonicalUnitEnablers
Description

Gets the CanonicalUnitEnablerList resulting from a search.

Returnosid.offering.rules.CanonicalUnitEnablerListthe canonical unit enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitEnablerQueryInspector
Description

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

Returnosid.offering.rules.CanonicalUnitEnablerQueryInspectorthe canonical unit enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitEnablerSearchResultsRecord
Description

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

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