OSID Logo
OSID Specifications
metering package
Version 3.1.0
Interfaceosid.metering.MeterSearch
Implementsosid.OsidSearch
Used Byosid.metering.MeterSearchSession
Description

The search interface for governing meter searches.

MethodsearchAmongMeters
Description

Execute this search among the given list of meters.

Parametersosid.id.IdListmeterIds list of meter Ids
ErrorsNULL_ARGUMENT meterIds is null
Compliancemandatory This method must be implemented.
MethodorderMeterResults
Description

Specify an ordering to the search results.

Parametersosid.metering.MeterSearchOrdermeterSearchOrder meter search order
ErrorsNULL_ARGUMENT meterSearchOrder is null
UNSUPPORTED meterSearchOrder is not of this service
Compliancemandatory This 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.TypemeterSearchRecordType a meter search record type
Returnosid.metering.records.MeterSearchRecord the meter search record
ErrorsNULL_ARGUMENT meterSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordTypeType(meterSearchRecordType) is false
Compliancemandatory This method must be implemented.