OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.CanonicalUnitProcessorEnablerQuery
Implementsosid.OsidEnablerQuery
Description

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

MethodmatchRuledCanonicalUnitProcessorId
Description

Matches enablers mapped to the canonical unit processor.

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

Clears the canonical unit processor Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledCanonicalUnitProcessorQuery
Description

Tests if a CanonicalUnitProcessorQuery is available.

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

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

Returnosid.offering.rules.CanonicalUnitProcessorQuerythe canonical unit processor query
ErrorsUNIMPLEMENTED supportsRuledCanonicalUnitProcessorQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledCanonicalUnitProcessorQuery() is true.
MethodmatchAnyRuledCanonicalUnitProcessor
Description

Matches enablers mapped to any canonical unit processor.

Parametersbooleanmatch true for enablers mapped to any canonical unit processor, false to match enablers mapped to no canonical unit processors
CompliancemandatoryThis method must be implemented.
MethodclearRuledCanonicalUnitProcessorTerms
Description

Clears the canonical unit processor query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCatalogueId
Description

Matches enablers 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.
MethodgetCanonicalUnitProcessorEnablerQueryRecord
Description

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

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