Interface | osid.metering.UtilitySearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing utility searches. | ||
Method | searchAmongUtilities | ||
Description |
Execute this search among the given list of utilities. | ||
Parameters | osid.id.IdList | utilityIds | list of utilities |
Errors | NULL_ARGUMENT | utilityIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderUtilityResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.metering.UtilitySearchOrder | utilitySearchOrder | utility search order |
Errors | NULL_ARGUMENT | utilitySearchOrder is null | |
UNSUPPORTED | utilitySearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getUtilitySearchRecord | ||
Description |
Gets the utility search record corresponding to the
given utility search record | ||
Parameters | osid.type.Type | utilitySearchRecordType | a utility search record type |
Return | osid.metering.records.UtilitySearchRecord | the utility search record | |
Errors | NULL_ARGUMENT | utilitySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(utilitySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |