OSID Logo
OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.UtilityQueryInspector
Implementsosid.OsidCatalogQueryInspector
Description

This is the query inspector for examining utility queries. Each method specifies an AND term while multiple terms from the same method produce a nested OR.

MethodgetMeterIdTerms
Description

Gets the meter Id terms.

Returnosid.search.terms.IdTerm[]the meter Id terms
CompliancemandatoryThis method must be implemented.
MethodgetMeterTerms
Description

Gets the meter terms.

Returnosid.metering.MeterQueryInspector[]the meter terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorUtilityIdTerms
Description

Gets the ancestor utility Id terms.

Returnosid.search.terms.IdTerm[]the utility Id terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorUtilityTerms
Description

Gets the ancestor utility terms.

Returnosid.metering.UtilityQueryInspector[]the utility terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantUtilityIdTerms
Description

Gets the descendant utility Id terms.

Returnosid.search.terms.IdTerm[]the utility Id terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantUtilityTerms
Description

Gets the descendant utility terms.

Returnosid.metering.UtilityQueryInspector[]the utility terms
CompliancemandatoryThis method must be implemented.
MethodgetUtilityQueryInspectorRecord
Description

Gets the utility query record interface corresponding to the given Utility record Type. Multiple retrievals produce a nested OR term.

Parametersosid.type.TypeutilityRecordTypea utility record type
Returnosid.metering.records.UtilityQueryInspectorRecordthe utility query inspector record
ErrorsNULL_ARGUMENT utilityRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(utilityRecordType) is false
CompliancemandatoryThis method must be implemented.