OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
metering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.metering.UtilitySearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getUtilities | ||
| Description |
Gets the utility list resulting from a search. | ||
| Return | osid.metering.UtilityList | the utility list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getUtilityQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.metering.UtilityQueryInspector | the utility query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getUtilitySearchResultsRecord | ||
| Description |
Gets the utility search results record corresponding to the given utility search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | utilitySearchRecordType | a utility search record type |
| Return | osid.metering.records.UtilitySearchResultsRecord | the utility search results 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. | |