OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.PoolQuery
Implementsosid.OsidGovernatorQuery
osid.OsidSubjugateableQuery
Description

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

MethodmatchBrokerId
Description

Sets the broker Id for this query.

Parametersosid.id.IdbrokerIdthe broker Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT brokerId is null
CompliancemandatoryThis method must be implemented.
MethodclearBrokerIdTerms
Description

Clears the broker Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBrokerQuery
Description

Tests if a BrokerQuery is available.

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

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

Returnosid.provisioning.BrokerQuerythe broker query
ErrorsUNIMPLEMENTED supportsBrokerQuery() is false
ComplianceoptionalThis method must be implemented if supportsBrokerQuery() is true.
MethodclearBrokerTerms
Description

Clears the broker query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProvisionableId
Description

Sets the provisionable Id for this query.

Parametersosid.id.IdprovisionableIdthe provisionable Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT provisionableId is null
CompliancemandatoryThis method must be implemented.
MethodclearProvisionableIdTerms
Description

Clears the provisionable Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionableQuery
Description

Tests if a ProvisionableQuery is available.

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

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

Returnosid.provisioning.ProvisionableQuerythe provisionable query
ErrorsUNIMPLEMENTED supportsProvisionableQuery() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableQuery() is true.
MethodmatchAnyProvisionable
Description

Matches pools that have any provisionable.

Parametersbooleanmatch true to match pools with any provisionable, false to match pools with no provisionable
CompliancemandatoryThis method must be implemented.
MethodclearProvisionableTerms
Description

Clears the provisionable query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSize
Description

Matches pools of the given size inclusive.

Parameterscardinalstartstart of range
cardinalendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end
CompliancemandatoryThis method must be implemented.
MethodmatchAnySize
Description

Matches pools with any known size.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearSizeTerms
Description

Clears the size query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDistributorId
Description

Sets the distributor Id for this query to match queues assigned to distributors.

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.
MethodgetPoolQueryRecord
Description

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

Parametersosid.type.TypepoolRecordTypea pool record type
Returnosid.provisioning.records.PoolQueryRecordthe pool query record
ErrorsNULL_ARGUMENT poolRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(poolRecordType) is false
CompliancemandatoryThis method must be implemented.