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

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

MethodgetCanonicalUnitProcessors
Description

Gets the CanonicalUnitProcessorList resulting from a search.

Returnosid.offering.rules.CanonicalUnitProcessorListthe canonical unit processor list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitProcessorQueryInspector
Description

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

Returnosid.offering.rules.CanonicalUnitProcessorQueryInspectorthe canonical unit processor query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitProcessorSearchResultsRecord
Description

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

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