OSID Logo
OSID Specifications
offering rules package
Version 3.1.0
Interfaceosid.offering.rules.CanonicalUnitProcessorQueryInspector
Implementsosid.OsidProcessorQueryInspector
Used Byosid.offering.rules.CanonicalUnitProcessorEnablerQueryInspector
osid.offering.rules.CanonicalUnitProcessorSearchResults
osid.offering.rules.CanonicalUnitProcessorSmartCatalogueSession
Description

This is the query inspector for examining canonical unit processor queries.

Like all OsidQueryInspectors, CanonicalUnitProcessorQueryInspector is stateful and must not be accessed by multiple processing threads.

MethodgetRuledCanonicalUnitIdTerms
Description

Gets the canonical unit Id query terms.

Returnosid.search.terms.IdTerm[] the query terms
Compliancemandatory This method must be implemented.
MethodgetRuledCanonicalUnitTerms
Description

Gets the canonical unit query terms.

Returnosid.offering.CanonicalUnitQueryInspector[] the query terms
Compliancemandatory This method must be implemented.
MethodgetCatalogueIdTerms
Description

Gets the catalogue Id query terms.

Returnosid.search.terms.IdTerm[] the query terms
Compliancemandatory This method must be implemented.
MethodgetCatalogueTerms
Description

Gets the catalogue query terms.

Returnosid.offering.CatalogueQueryInspector[] the query terms
Compliancemandatory This method must be implemented.
MethodgetCanonicalUnitProcessorQueryInspectorRecord
Description

Gets the canonical unit processor query inspector record corresponding to the given CanonicalUnitProcessor record Type.

Parametersosid.type.TypecanonicalUnitProcessorRecordType a canonical unit processor record type
Returnosid.offering.rules.records.CanonicalUnitProcessorQueryInspectorRecord the canonical unit processor query inspector record
ErrorsNULL_ARGUMENT canonicalUnitProcessorRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(canonicalUnitProcessorRecordType) is false
Compliancemandatory This method must be implemented.