OSID Logo
OSID Specifications
offering rules package
Version 3.1.0
Interfaceosid.offering.rules.CanonicalUnitProcessorSearchResults
Implementsosid.OsidSearchResults
Used Byosid.offering.rules.CanonicalUnitProcessorSearchSession
Description

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

MethodgetCanonicalUnitProcessors
Description

Gets the CanonicalUnitProcessorList resulting from a search.

Returnosid.offering.rules.CanonicalUnitProcessorList the canonical unit processor list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetCanonicalUnitProcessorQueryInspector
Description

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

Returnosid.offering.rules.CanonicalUnitProcessorQueryInspector the canonical unit processor query inspector
Compliancemandatory This 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.TypecanonicalUnitProcessorSearchRecordType a canonical unit processor search record type
Returnosid.offering.rules.records.CanonicalUnitProcessorSearchResultsRecord the canonical unit processor search results record
ErrorsNULL_ARGUMENT canonicalUnitProcessorSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(canonicalUnitProcessorSearchRecordType) is false
Compliancemandatory This method must be implemented.