OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.PoolProcessorEnablerQuery
Implementsosid.OsidEnablerQuery
Description

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

MethodmatchRuledPoolProcessorId
Description

Matches enablers mapped to the pool processor.

Parametersosid.id.IdpoolProcessorIdthe pool processor Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT poolProcessorId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledPoolProcessorIdTerms
Description

Clears the pool processor Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledPoolProcessorQuery
Description

Tests if a PoolProcessorQuery is available.

Returnboolean true if a pool processor query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledPoolProcessorQuery
Description

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

Returnosid.provisioning.rules.PoolProcessorQuerythe pool processor query
ErrorsUNIMPLEMENTED supportsRuledPoolProcessorQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledPoolProcessorQuery() is true.
MethodmatchAnyRuledPoolProcessor
Description

Matches enablers mapped to any pool processor.

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

Clears the pool processor query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDistributorId
Description

Matches enablers mapped to the distributor.

Parametersosid.id.IddistributorIdthe distributor Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT distributorId is null
CompliancemandatoryThis method must be implemented.
MethodclearDistributorIdTerms
Description

Clears the distributor Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDistributorQuery
Description

Tests if a DistributorQuery is available.

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

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

Returnosid.provisioning.DistributorQuerythe distributor query
ErrorsUNIMPLEMENTED supportsDistributorQuery() is false
ComplianceoptionalThis method must be implemented if supportsDistributorQuery() is true.
MethodclearDistributorTerms
Description

Clears the distributor query terms.

CompliancemandatoryThis method must be implemented.
MethodgetPoolProcessorEnablerQueryRecord
Description

Gets the pool processor enabler query record corresponding to the given PoolProcessorEnabler record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypepoolProcessorEnablerRecordTypea pool processor enabler record type
Returnosid.provisioning.rules.records.PoolProcessorEnablerQueryRecordthe pool processor enabler query record
ErrorsNULL_ARGUMENT poolProcessorEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(poolProcessorEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.