| Interface | osid.metering.UtilityQuerySession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods for searching Utilities may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | canSearchUtilities | ||
| Description |
Tests if this user can perform | ||
| Return | boolean | false if search methods are not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getUtilityQuery | ||
| Description |
Gets a utility query. | ||
| Return | osid.metering.UtilityQuery | the utility query | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getUtilitiesByQuery | ||
| Description |
Gets a list of | ||
| Parameters | osid.metering.UtilityQuery | utilityQuery | the utility query |
| Return | osid.metering.UtilityList | the returned UtilityList | |
| Errors | NULL_ARGUMENT | utilityQuery is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | utilityQuery is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |