Interface | osid.metering.UtilityQuery | ||
---|---|---|---|
Implements | osid.OsidCatalogQuery | ||
Description |
This is the query for searching for utilities. Each method
specifies an | ||
Method | matchMeterId | ||
Description |
Sets a meter | ||
Parameters | osid.id.Id | meterId | a meter Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | meterId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMeterIdTerms | ||
Description |
Clears the meter | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsMeterQuery | ||
Description |
Tests if a meter query is available. | ||
Return | boolean | true if a meter query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getMeterQuery | ||
Description |
Gets the query for a meter. | ||
Return | osid.metering.MeterQuery | the meter query | |
Errors | UNIMPLEMENTED | supportsMeterQuery() is false | |
Compliance | optional | This method must be implemented if supportsMeterQuery() is
true. | |
Method | matchAnyMeter | ||
Description |
Matches utilities with any meter. | ||
Parameters | boolean | match | true to match utilities with any meter, false
to match utilities with no meters |
Compliance | mandatory | This method must be implemented. | |
Method | clearMeterTerms | ||
Description |
Clears the meter query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAncestorUtilityId | ||
Description |
Sets the utility | ||
Parameters | osid.id.Id | utilityId | a utility Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | utilityId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorUtilityIdTerms | ||
Description |
Clears the ancestor utility | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAncestorUtilityQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a utility query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorUtilityQuery | ||
Description |
Gets the query for a utility. Multiple retrievals
produce a nested | ||
Return | osid.metering.UtilityQuery | the utility query | |
Errors | UNIMPLEMENTED | supportsAncestorUtilityQuery() is false | |
Compliance | optional | This method must be implemented if supportsAncestorUtilityQuery()
is true. | |
Method | clearAncestorUtilityTerms | ||
Description |
Clears the ancestor utility query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyAncestorUtility | ||
Description |
Matches utilities with any ancestor. | ||
Parameters | boolean | match | true to match utilities with any ancestor, false
to match root utilities |
Compliance | mandatory | This method must be implemented. | |
Method | matchDescendantUtilityId | ||
Description |
Sets the utility | ||
Parameters | osid.id.Id | utilityId | a utility Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | utilityId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantUtilityIdTerms | ||
Description |
Clears the descendant utility | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDescendantUtilityQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a utility query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantUtilityQuery | ||
Description |
Gets the query for a utility. Multiple retrievals
produce a nested | ||
Return | osid.metering.UtilityQuery | the utility query | |
Errors | UNIMPLEMENTED | supportsDescendantUtilityQuery() is false | |
Compliance | optional | This method must be implemented if supportsDescendantUtilityQuery()
is true. | |
Method | matchAnyDescendantUtility | ||
Description |
Matches utilities with any descendant. | ||
Parameters | boolean | match | true to match utilities with any descendant, false
to match leaf utilities |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantUtilityTerms | ||
Description |
Clears the descendant utility query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getUtilityQueryRecord | ||
Description |
Gets the utility query record corresponding to the
given | ||
Parameters | osid.type.Type | utilityRecordType | a utility record type |
Return | osid.metering.records.UtilityQueryRecord | the utility query 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. |