| Interface | osid.metering.MeterSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing meter searches. | ||
| Method | searchAmongMeters | ||
| Description |
Execute this search among the given list of meters. | ||
| Parameters | osid.id.IdList | meterIds | list of meter Ids |
| Errors | NULL_ARGUMENT | meterIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderMeterResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.metering.MeterSearchOrder | meterSearchOrder | meter search order |
| Errors | NULL_ARGUMENT | meterSearchOrder is null | |
| UNSUPPORTED | meterSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getMeterSearchRecord | ||
| Description |
Gets the meter search record corresponding to the given
meter search record | ||
| Parameters | osid.type.Type | meterSearchRecordType | a meter search record type |
| Return | osid.metering.records.MeterSearchRecord | the meter search record | |
| Errors | NULL_ARGUMENT | meterSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordTypeType(meterSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |