Interface | osid.provisioning.rules.PoolConstrainerQuery | ||
---|---|---|---|
Implements | osid.OsidConstrainerQuery | ||
Description |
This is the query for searching pool constrainers. Each
method match specifies an | ||
Method | matchRuledPoolId | ||
Description |
Matches mapped to a pool. | ||
Parameters | osid.id.Id | distributorId | the pool 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 | clearRuledPoolIdTerms | ||
Description |
Clears the pool | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledPoolQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a pool query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledPoolQuery | ||
Description |
Gets the query for a pool. Multiple retrievals produce
a nested | ||
Return | osid.provisioning.PoolQuery | the pool query | |
Errors | UNIMPLEMENTED | supportsRuledPoolQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledPoolQuery()
is true. | |
Method | matchAnyRuledPool | ||
Description |
Matches mapped to any pool. | ||
Parameters | boolean | match | true for mapped to any pool, false to match
mapped to no pools |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledPoolTerms | ||
Description |
Clears the pool 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 | getPoolConstrainerQueryRecord | ||
Description |
Gets the pool constrainer query record corresponding to
the given | ||
Parameters | osid.type.Type | poolConstrainerRecordType | a pool constrainer record type |
Return | osid.provisioning.rules.records.PoolConstrainerQueryRecord | the pool constrainer query record | |
Errors | NULL_ARGUMENT | poolConstrainerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(poolConstrainerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |