| Interface | osid.metering.UtilityQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining utility queries.
Each method specifies an | ||
| Method | getMeterIdTerms | ||
| Description |
Gets the meter | ||
| Return | osid.search.terms.IdTerm[] | the meter Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMeterTerms | ||
| Description |
Gets the meter terms. | ||
| Return | osid.metering.MeterQueryInspector[] | the meter terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorUtilityIdTerms | ||
| Description |
Gets the ancestor utility | ||
| Return | osid.search.terms.IdTerm[] | the utility Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorUtilityTerms | ||
| Description |
Gets the ancestor utility terms. | ||
| Return | osid.metering.UtilityQueryInspector[] | the utility terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantUtilityIdTerms | ||
| Description |
Gets the descendant utility | ||
| Return | osid.search.terms.IdTerm[] | the utility Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantUtilityTerms | ||
| Description |
Gets the descendant utility terms. | ||
| Return | osid.metering.UtilityQueryInspector[] | the utility terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getUtilityQueryInspectorRecord | ||
| Description |
Gets the utility query record interface corresponding
to the given | ||
| Parameters | osid.type.Type | utilityRecordType | a utility record type |
| Return | osid.metering.records.UtilityQueryInspectorRecord | the utility query inspector record | |
| Errors | NULL_ARGUMENT | utilityRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(utilityRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |