Interface | osid.provisioning.rules.BrokerConstrainerEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching broker constrainer
enablers. Each method match specifies an | ||
Method | matchRuledBrokerConstrainerId | ||
Description |
Matches enablers mapped to the broker constrainer. | ||
Parameters | osid.id.Id | brokerConstrainerId | the broker constrainer Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | brokerConstrainerId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledBrokerConstrainerIdTerms | ||
Description |
Clears the broker constrainer | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledBrokerConstrainerQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a broker constrainer query is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledBrokerConstrainerQuery | ||
Description |
Gets the query for a broker constrainer. Multiple
retrievals produce a nested | ||
Return | osid.provisioning.rules.BrokerConstrainerQuery | the broker constrainer query | |
Errors | UNIMPLEMENTED | supportsRuledBrokerConstrainerQuery() is false
| |
Compliance | optional | This method must be implemented if
supportsRuledBrokerConstrainerQuery() is true. | |
Method | matchAnyRuledBrokerConstrainer | ||
Description |
Matches enablers mapped to any broker constrainer. | ||
Parameters | boolean | match | true for enablers mapped to any broker constrainer,
false to match enablers mapped to no broker constrainers |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledBrokerConstrainerTerms | ||
Description |
Clears the broker constrainer query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDistributorId | ||
Description |
Matches enablers 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 | getBrokerConstrainerEnablerQueryRecord | ||
Description |
Gets the broker constrainer enabler query record
corresponding to the given | ||
Parameters | osid.type.Type | brokerConstrainerEnablerRecordType | a broker constrainer enabler record type |
Return | osid.provisioning.rules.records.BrokerConstrainerEnablerQueryRecord | the broker constrainer enabler query record | |
Errors | NULL_ARGUMENT | brokerConstrainerEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(brokerConstrainerEnablerRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |