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

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

MethodmatchSizeLimit
Description

Matches queues of the given size limit 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.
MethodmatchAnySizeLimit
Description

Matches queues with any known size limit.

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

Clears the size limit query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRequiresProvisions
Description

Matches constraints that require provisions.

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

Clears the requires provisions query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRequiredProvisionPoolId
Description

Sets the required provision pool Id for this query.

Parametersosid.id.IdpoolIda pool Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT poolId is null
CompliancemandatoryThis method must be implemented.
MethodclearRequiredProvisionPoolIdTerms
Description

Clears the required provision pool Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRequiredProvisionPoolQuery
Description

Tests if a PoolQuery is available.

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

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

Returnosid.provisioning.PoolQuerythe required provision pool query
ErrorsUNIMPLEMENTED supportsRequiredProvisionPoolQuery() is false
ComplianceoptionalThis method must be implemented if supportsRequiredProvisionPoolQuery() is true.
MethodmatchAnyRequiredProvisionPool
Description

Matches queues that have any required provision pool.

Parametersbooleanmatch true to match queues with any required provision pool, false to match queues with no required provision pool
CompliancemandatoryThis method must be implemented.
MethodclearRequiredProvisionPoolTerms
Description

Clears the required provision pool query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRuledQueueId
Description

Matches mapped to a queue.

Parametersosid.id.IdqueueIdthe queue Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT queueId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledQueueIdTerms
Description

Clears the queue Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledQueueQuery
Description

Tests if a QueueQuery is available.

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

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

Returnosid.provisioning.QueueQuerythe queue query
ErrorsUNIMPLEMENTED supportsRuledQueueQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledQueueQuery() is true.
MethodmatchAnyRuledQueue
Description

Matches mapped to any queue.

Parametersbooleanmatch true for mapped to any queue, false to match mapped to no queues
CompliancemandatoryThis method must be implemented.
MethodclearRuledQueueTerms
Description

Clears the queue 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.
MethodgetQueueConstrainerQueryRecord
Description

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

Parametersosid.type.TypequeueConstrainerRecordTypea queue constrainer record type
Returnosid.provisioning.rules.records.QueueConstrainerQueryRecordthe queue constrainer query record
ErrorsNULL_ARGUMENT queueConstrainerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(queueConstrainerRecordType) is false
CompliancemandatoryThis method must be implemented.