OSID Logo
OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.MeterSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetMeters
Description

Gets the meter list resulting from a search.

Returnosid.metering.MeterListthe meter list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetMeterQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.metering.MeterQueryInspectorthe meter query inspector
CompliancemandatoryThis method must be implemented.
MethodgetMeterSearchResultsRecord
Description

Gets the meter search results record corresponding to the given meter search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypemeterSearchRecordTypea meter search record type
Returnosid.metering.records.MeterSearchResultsRecordthe meter search results record
ErrorsNULL_ARGUMENT meterSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordTypeType(meterSearchRecordType) is false
CompliancemandatoryThis method must be implemented.