| Interface | osid.resourcing.rules.CommissionEnablerQuery | ||
|---|---|---|---|
| Implements | osid.OsidEnablerQuery | ||
| Description | 
                 This is the query for searching commission enablers. Each 
                method match specifies an   | ||
| Method | matchRuledCommissionId | ||
| Description | 
                     Matches mapped to a commission.  | ||
| Parameters | osid.id.Id | foundryId | the commission  Id   | 
boolean | match |  true  for a positive match,  false  for a 
negative match  | |
| Errors | NULL_ARGUMENT |  foundryId  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | clearRuledCommissionIdTerms | ||
| Description | 
                     Clears the commission   | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsRuledCommissionQuery | ||
| Description | 
                     Tests if an   | ||
| Return | boolean |  true  if a commission query is available,  false 
 otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRuledCommissionQuery | ||
| Description | 
                     Gets the query for a commission. Multiple retrievals 
                    produce a nested   | ||
| Return | osid.resourcing.CommissionQuery | the commission query | |
| Errors | UNIMPLEMENTED |  supportsRuledCommissionQuery()  is  false   |                 |
| Compliance | optional | This method must be implemented if  supportsRuledCommissionQuery() 
 is  true.   | |
| Method | matchAnyRuledCommission | ||
| Description | 
                     Matches mapped to any commission.  | ||
| Parameters | boolean | match |  true  for mapped to any commission,  false  to 
match mapped to no commissions  | 
| Compliance | mandatory | This method must be implemented. | |
| Method | clearRuledCommissionTerms | ||
| Description | 
                     Clears the commission query terms.  | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | matchFoundryId | ||
| Description | 
                     Matches mapped to the foundry.  | ||
| Parameters | osid.id.Id | foundryId | the foundry  Id   | 
boolean | match |  true  for a positive match,  false  for a 
negative match  | |
| Errors | NULL_ARGUMENT |  foundryId  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | clearFoundryIdTerms | ||
| Description | 
                     Clears the foundry   | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsFoundryQuery | ||
| Description | 
                     Tests if a   | ||
| Return | boolean |  true  if a foundry query is available,  false  
otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFoundryQuery | ||
| Description | 
                     Gets the query for a foundry. Multiple retrievals 
                    produce a nested   | ||
| Return | osid.resourcing.FoundryQuery | the foundry query | |
| Errors | UNIMPLEMENTED |  supportsFoundryQuery()  is  false   |                 |
| Compliance | optional | This method must be implemented if  supportsFoundryQuery()  is 
 true.   | |
| Method | clearFoundryTerms | ||
| Description | 
                     Clears the foundry query terms.  | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommissionEnablerQueryRecord | ||
| Description | 
                     Gets the commission enabler query record corresponding 
                    to the given   | ||
| Parameters | osid.type.Type | commissionEnablerRecordType | an commission enabler record type | 
| Return | osid.resourcing.rules.records.CommissionEnablerQueryRecord | the commission enabler query record | |
| Errors | NULL_ARGUMENT |  commissionEnablerRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(commissionEnablerRecordType)  is  false 
  |                 ||
| Compliance | mandatory | This method must be implemented. | |