Interface MeterQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface MeterQueryInspector extends OsidObjectQueryInspector

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

  • Method Details

    • getUtilityIdTerms

      IdTerm[] getUtilityIdTerms()
      Gets the utility Id terms.
      Returns:
      the utility Id terms
      Compliance:
      mandatory - This method must be implemented.
    • getUtilityTerms

      UtilityQueryInspector[] getUtilityTerms()
      Gets the utility terms.
      Returns:
      the utility terms
      Compliance:
      mandatory - This method must be implemented.
    • getMeterQueryInspectorRecord

      MeterQueryInspectorRecord getMeterQueryInspectorRecord(Type meterRecordType) throws OperationFailedException
      Gets the meter query inspector record corresponding to the given Meter record Type . Multiple retrievals produce a nested OR term.
      Parameters:
      meterRecordType - a meter record type
      Returns:
      the meter query inspector record
      Throws:
      NullArgumentException - meterRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(meterRecordType) is false
      Compliance:
      mandatory - This method must be implemented.