OSID Logo
OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.MeterQuery
Implementsosid.OsidObjectQuery
Description

This is the query for searching meters. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchUtilityId
Description

Sets the utility Id for this query.

Parametersosid.id.IdutilityIdthe utility Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT utilityId is null
CompliancemandatoryThis method must be implemented.
MethodclearUtilityIdTerms
Description

Clears the utility Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsUtilityQuery
Description

Tests if a UtilityQuery is available.

Returnboolean true if a utility query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetUtilityQuery
Description

Gets the query for a utility. Multiple retrievals produce a nested OR term.

Returnosid.metering.UtilityQuerythe utility query
ErrorsUNIMPLEMENTED supportsUtilityQuery() is false
ComplianceoptionalThis method must be implemented if supportsUtilityQuery() is true.
MethodclearUtilityTerms
Description

Clears the utility query terms.

CompliancemandatoryThis method must be implemented.
MethodgetMeterQueryRecord
Description

Gets the meter query record corresponding to the given Meter record Type. Multiple retrievals produce a nested OR term.

Parametersosid.type.TypemeterRecordTypea meter record type
Returnosid.metering.records.MeterQueryRecordthe meter query record
ErrorsNULL_ARGUMENT meterRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(meterRecordType) is false
CompliancemandatoryThis method must be implemented.