Interface | osid.provisioning.rules.BrokerConstrainerQuery | ||
---|---|---|---|
Implements | osid.OsidConstrainerQuery | ||
Description |
This is the query for searching broker constrainers. Each
method match specifies an | ||
Method | matchRuledBrokerId | ||
Description |
Matches mapped to a broker. | ||
Parameters | osid.id.Id | distributorId | the broker 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 | clearRuledBrokerIdTerms | ||
Description |
Clears the broker | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledBrokerQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a broker query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledBrokerQuery | ||
Description |
Gets the query for a broker. Multiple retrievals
produce a nested | ||
Return | osid.provisioning.BrokerQuery | the broker query | |
Errors | UNIMPLEMENTED | supportsRuledBrokerQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledBrokerQuery()
is true. | |
Method | matchAnyRuledBroker | ||
Description |
Matches mapped to any broker. | ||
Parameters | boolean | match | true for mapped to any broker, false to match
mapped to no brokers |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledBrokerTerms | ||
Description |
Clears the broker 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 | getBrokerConstrainerQueryRecord | ||
Description |
Gets the broker constrainer query record corresponding
to the given | ||
Parameters | osid.type.Type | brokerConstrainerRecordType | a broker constrainer record type |
Return | osid.provisioning.rules.records.BrokerConstrainerQueryRecord | the broker constrainer query record | |
Errors | NULL_ARGUMENT | brokerConstrainerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(brokerConstrainerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |