OSID Logo
OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.MeterSearch
Implementsosid.OsidSearch
Description

The search interface for governing meter searches.

MethodsearchAmongMeters
Description

Execute this search among the given list of meters.

Parametersosid.id.IdListmeterIdslist of meter Ids
ErrorsNULL_ARGUMENT meterIds is null
CompliancemandatoryThis method must be implemented.
MethodorderMeterResults
Description

Specify an ordering to the search results.

Parametersosid.metering.MeterSearchOrdermeterSearchOrdermeter search order
ErrorsNULL_ARGUMENT meterSearchOrder is null
UNSUPPORTED meterSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetMeterSearchRecord
Description

Gets the meter search 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.MeterSearchRecordthe meter search record
ErrorsNULL_ARGUMENT meterSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordTypeType(meterSearchRecordType) is false
CompliancemandatoryThis method must be implemented.