Interface | osid.provisioning.rules.QueueConstrainerQuery | ||
---|---|---|---|
Implements | osid.OsidConstrainerQuery | ||
Description |
This is the query for searching queue constrainers. Each
method match specifies a | ||
Method | matchSizeLimit | ||
Description |
Matches queues of the given size limit inclusive. | ||
Parameters | cardinal | start | start of range |
cardinal | end | end of range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | start is greater than end | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnySizeLimit | ||
Description |
Matches queues with any known size limit. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearSizeLimitTerms | ||
Description |
Clears the size limit query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRequiresProvisions | ||
Description |
Matches constraints that require provisions. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearRequiresProvisionsTerms | ||
Description |
Clears the requires provisions query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRequiredProvisionPoolId | ||
Description |
Sets the required provision pool | ||
Parameters | osid.id.Id | poolId | a pool Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | poolId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRequiredProvisionPoolIdTerms | ||
Description |
Clears the required provision pool | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequiredProvisionPoolQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a required provision pool query is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequiredProvisionPoolQuery | ||
Description |
Gets the query for a | ||
Return | osid.provisioning.PoolQuery | the required provision pool query | |
Errors | UNIMPLEMENTED | supportsRequiredProvisionPoolQuery() is false | |
Compliance | optional | This method must be implemented if
supportsRequiredProvisionPoolQuery() is true. | |
Method | matchAnyRequiredProvisionPool | ||
Description |
Matches queues that have any required provision pool. | ||
Parameters | boolean | match | true to match queues with any required provision pool,
false to match queues with no required provision pool |
Compliance | mandatory | This method must be implemented. | |
Method | clearRequiredProvisionPoolTerms | ||
Description |
Clears the required provision pool query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRuledQueueId | ||
Description |
Matches mapped to a queue. | ||
Parameters | osid.id.Id | queueId | the queue Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | queueId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledQueueIdTerms | ||
Description |
Clears the queue | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledQueueQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a queue query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledQueueQuery | ||
Description |
Gets the query for a queue. Multiple retrievals produce
a nested | ||
Return | osid.provisioning.QueueQuery | the queue query | |
Errors | UNIMPLEMENTED | supportsRuledQueueQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledQueueQuery()
is true. | |
Method | matchAnyRuledQueue | ||
Description |
Matches mapped to any queue. | ||
Parameters | boolean | match | true for mapped to any queue, false to match
mapped to no queues |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledQueueTerms | ||
Description |
Clears the queue query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDistributorId | ||
Description |
Matches mapped to the distributor. | ||
Parameters | osid.id.Id | distributorId | the distributor Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | distributorId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDistributorIdTerms | ||
Description |
Clears the distributor | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDistributorQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a distributor query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistributorQuery | ||
Description |
Gets the query for a distributor. Multiple retrievals
produce a nested | ||
Return | osid.provisioning.DistributorQuery | the distributor query | |
Errors | UNIMPLEMENTED | supportsDistributorQuery() is false | |
Compliance | optional | This method must be implemented if supportsDistributorQuery()
is true. | |
Method | clearDistributorTerms | ||
Description |
Clears the distributor query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerQueryRecord | ||
Description |
Gets the queue constrainer query record corresponding
to the given | ||
Parameters | osid.type.Type | queueConstrainerRecordType | a queue constrainer record type |
Return | osid.provisioning.rules.records.QueueConstrainerQueryRecord | the queue constrainer query record | |
Errors | NULL_ARGUMENT | queueConstrainerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(queueConstrainerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |