Interface | osid.provisioning.PoolQuery | ||
---|---|---|---|
Implements | osid.OsidGovernatorQuery | ||
osid.OsidSubjugateableQuery | |||
Description |
This is the query for searching pools. Each method match
specifies an | ||
Method | matchBrokerId | ||
Description |
Sets the broker | ||
Parameters | osid.id.Id | brokerId | the broker Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | brokerId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearBrokerIdTerms | ||
Description |
Clears the broker | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsBrokerQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a broker query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerQuery | ||
Description |
Gets the query for a broker. Multiple retrievals
produce a nested | ||
Return | osid.provisioning.BrokerQuery | the broker query | |
Errors | UNIMPLEMENTED | supportsBrokerQuery() is false | |
Compliance | optional | This method must be implemented if supportsBrokerQuery() is
true. | |
Method | clearBrokerTerms | ||
Description |
Clears the broker query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchProvisionableId | ||
Description |
Sets the provisionable | ||
Parameters | osid.id.Id | provisionableId | the provisionable Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | provisionableId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearProvisionableIdTerms | ||
Description |
Clears the provisionable | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionableQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a provisionable query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionableQuery | ||
Description |
Gets the query for a | ||
Return | osid.provisioning.ProvisionableQuery | the provisionable query | |
Errors | UNIMPLEMENTED | supportsProvisionableQuery() is false | |
Compliance | optional | This method must be implemented if supportsProvisionableQuery()
is true. | |
Method | matchAnyProvisionable | ||
Description |
Matches pools that have any provisionable. | ||
Parameters | boolean | match | true to match pools with any provisionable, false
to match pools with no provisionable |
Compliance | mandatory | This method must be implemented. | |
Method | clearProvisionableTerms | ||
Description |
Clears the provisionable query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSize | ||
Description |
Matches pools of the given size 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 | matchAnySize | ||
Description |
Matches pools with any known size. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearSizeTerms | ||
Description |
Clears the size query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDistributorId | ||
Description |
Sets 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 | getPoolQueryRecord | ||
Description |
Gets the pool query record corresponding to the given
| ||
Parameters | osid.type.Type | poolRecordType | a pool record type |
Return | osid.provisioning.records.PoolQueryRecord | the pool query record | |
Errors | NULL_ARGUMENT | poolRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(poolRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |