OSID - osid.metering.UtilityQuery Service Interface Definition

Interface	osid.metering.UtilityQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.metering.MeterQuery`
	`osid.metering.UtilityQuery`
	`osid.metering.UtilityQuerySession`
	`osid.metering.UtilitySearchSession`
Description	This is the query for searching for utilities. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchMeterId
Description	Sets a meter `Id`.
Parameters	`osid.id.Id`	`meterId`	a meter `Id`
Parameters	`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 `Id` query terms.
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 `Id` for this query to match utilities that have the specified utility as an ancestor.
Parameters	`osid.id.Id`	`utilityId`	a utility `Id`
Parameters	`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 `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorUtilityQuery
Description	Tests if a `UtilityQuery` is available.
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 `OR` term.
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 `Id` for this query to match utilities that have the specified utility as a descendant.
Parameters	`osid.id.Id`	`utilityId`	a utility `Id`
Parameters	`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 `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantUtilityQuery
Description	Tests if a `UtilityQuery` is available.
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 `OR` term.
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 `Utility` record `Type` .Multiple record retrievals produce a nested boolean `OR` term.
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.