Interface | osid.provisioning.rules.BrokerProcessorEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching broker processor enablers.
Each method match specifies an | ||
Method | matchRuledBrokerProcessorId | ||
Description |
Matches enablers mapped to the broker processor. | ||
Parameters | osid.id.Id | brokerProcessorId | the broker processor Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | brokerProcessorId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledBrokerProcessorIdTerms | ||
Description |
Clears the broker processor | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledBrokerProcessorQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a broker processor query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledBrokerProcessorQuery | ||
Description |
Gets the query for a broker processor. Multiple
retrievals produce a nested | ||
Return | osid.provisioning.rules.BrokerProcessorQuery | the broker processor query | |
Errors | UNIMPLEMENTED | supportsRuledBrokerProcessorQuery() is false | |
Compliance | optional | This method must be implemented if
supportsRuledBrokerProcessorQuery() is true. | |
Method | matchAnyRuledBrokerProcessor | ||
Description |
Matches enablers mapped to any broker processor. | ||
Parameters | boolean | match | true for enablers mapped to any broker processor,
false to match enablers mapped to no broker processors |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledBrokerProcessorTerms | ||
Description |
Clears the broker processor 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 | getBrokerProcessorEnablerQueryRecord | ||
Description |
Gets the broker processor enabler query record
corresponding to the given | ||
Parameters | osid.type.Type | brokerProcessorEnablerRecordType | a broker processor enabler record type |
Return | osid.provisioning.rules.records.BrokerProcessorEnablerQueryRecord | the broker processor enabler query record | |
Errors | NULL_ARGUMENT | brokerProcessorEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(brokerProcessorEnablerRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |