Interface | osid.metering.MeterSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getMeters | ||
Description |
Gets the meter list resulting from a search. | ||
Return | osid.metering.MeterList | the meter list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getMeterQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.metering.MeterQueryInspector | the meter query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getMeterSearchResultsRecord | ||
Description |
Gets the meter search results record corresponding to
the given meter search record | ||
Parameters | osid.type.Type | meterSearchRecordType | a meter search record type |
Return | osid.metering.records.MeterSearchResultsRecord | the meter search results 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. |