OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.CanonicalUnitProcessorQuery
Implementsosid.OsidProcessorQuery
Description

This is the query for searching canonical unit processors. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRuledCanonicalUnitId
Description

Matches mapped to the canonical unit.

Parametersosid.id.IdcanonicalUnitIdthe canonical unit Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT canonicalUnitId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledCanonicalUnitIdTerms
Description

Clears the canonical unit Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledCanonicalUnitQuery
Description

Tests if a CanonicalUnitQuery is available.

Returnboolean true if a canonical unit query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledCanonicalUnitQuery
Description

Gets the query for a canonical unit. Multiple retrievals produce a nested OR term.

Returnosid.offering.CanonicalUnitQuerythe canonical unit query
ErrorsUNIMPLEMENTED supportsRuledCanonicalUnitQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledCanonicalUnitQuery() is true.
MethodmatchAnyRuledCanonicalUnit
Description

Matches mapped to any canonical unit.

Parametersbooleanmatch true for mapped to any canonical unit, false to match mapped to no canonicalUnit
CompliancemandatoryThis method must be implemented.
MethodclearRuledCanonicalUnitTerms
Description

Clears the canonical unit query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCatalogueId
Description

Matches mapped to the catalogue.

Parametersosid.id.IdcatalogueIdthe catalogue Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT catalogueId is null
CompliancemandatoryThis method must be implemented.
MethodclearCatalogueIdTerms
Description

Clears the catalogue Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCatalogueQuery
Description

Tests if a CatalogueQuery is available.

Returnboolean true if a catalogue query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCatalogueQuery
Description

Gets the query for a catalogue. Multiple retrievals produce a nested OR term.

Returnosid.offering.CatalogueQuerythe catalogue query
ErrorsUNIMPLEMENTED supportsCatalogueQuery() is false
ComplianceoptionalThis method must be implemented if supportsCatalogueQuery() is true.
MethodclearCatalogueTerms
Description

Clears the catalogue query terms.

CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitProcessorQueryRecord
Description

Gets the canonical unit processor query record corresponding to the given CanonicalUnitProcessor record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypecanonicalUnitProcessorRecordTypea canonical unit processor record type
Returnosid.offering.rules.records.CanonicalUnitProcessorQueryRecordthe canonical unit processor query record
ErrorsNULL_ARGUMENT canonicalUnitProcessorRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(canonicalUnitProcessorRecordType) is false
CompliancemandatoryThis method must be implemented.