OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.PoolConstrainerQuery
Implementsosid.OsidConstrainerQuery
Description

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

MethodmatchRuledPoolId
Description

Matches mapped to a pool.

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

Clears the pool Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledPoolQuery
Description

Tests if a PoolQuery is available.

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

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

Returnosid.provisioning.PoolQuerythe pool query
ErrorsUNIMPLEMENTED supportsRuledPoolQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledPoolQuery() is true.
MethodmatchAnyRuledPool
Description

Matches mapped to any pool.

Parametersbooleanmatch true for mapped to any pool, false to match mapped to no pools
CompliancemandatoryThis method must be implemented.
MethodclearRuledPoolTerms
Description

Clears the pool query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDistributorId
Description

Matches 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.
MethodgetPoolConstrainerQueryRecord
Description

Gets the pool constrainer query record corresponding to the given PoolConstrainer record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypepoolConstrainerRecordTypea pool constrainer record type
Returnosid.provisioning.rules.records.PoolConstrainerQueryRecordthe pool constrainer query record
ErrorsNULL_ARGUMENT poolConstrainerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(poolConstrainerRecordType) is false
CompliancemandatoryThis method must be implemented.