| Interface | osid.metering.MeterQuery | ||
|---|---|---|---|
| Implements | osid.OsidObjectQuery | ||
| Description | 
                 This is the query for searching meters. Each method 
                specifies an   | ||
| Method | matchUtilityId | ||
| Description | 
                     Sets the utility   | ||
| Parameters | osid.id.Id | utilityId | the utility  Id   | 
boolean | match |  true  for a positive match,  false  for a 
negative match  | |
| Errors | NULL_ARGUMENT |  utilityId  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | clearUtilityIdTerms | ||
| Description | 
                     Clears the utility   | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsUtilityQuery | ||
| Description | 
                     Tests if a   | ||
| Return | boolean |  true  if a utility query is available,  false  
otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getUtilityQuery | ||
| Description | 
                     Gets the query for a utility. Multiple retrievals 
                    produce a nested   | ||
| Return | osid.metering.UtilityQuery | the utility query | |
| Errors | UNIMPLEMENTED |  supportsUtilityQuery()  is  false   |                 |
| Compliance | optional | This method must be implemented if  supportsUtilityQuery()  is 
 true.   | |
| Method | clearUtilityTerms | ||
| Description | 
                     Clears the utility query terms.  | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getMeterQueryRecord | ||
| Description | 
                     Gets the meter query record corresponding to the given 
                      | ||
| Parameters | osid.type.Type | meterRecordType | a meter record type | 
| Return | osid.metering.records.MeterQueryRecord | the meter query record | |
| Errors | NULL_ARGUMENT |  meterRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(meterRecordType)  is  false   |                 ||
| Compliance | mandatory | This method must be implemented. | |