OSID - osid.metering.MeterQuerySession Service Interface Definition

Interface	osid.metering.MeterQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.metering.StatisticSearchSession`
Implemented By	`osid.metering.MeterSearchSession`
Used By	`osid.metering.MeteringManager`
Used By	`osid.metering.MeteringProxyManager`
Description	This session provides methods for searching among meters. The search query is constructed using the `MeterQuery`. This session defines views that offer differing behaviors for searching. federated utility view: searches include meters in utilities of which this utility is an ancestor in the utility hierarchy isolated utility view: searches are restricted to meters in this utility only
Method	getUtilityId
Description	Gets the `Utility` `Id` associated with this session.
Return	`osid.id.Id`		the `Utility Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getUtility
Description	Gets the `Utility` associated with this session.
Return	`osid.metering.Utility`		the `Utility` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchMeters
Description	Tests if this user can perform `Meter` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedUtilityView
Description	Federates the view for methods in this session. A federated view will include meters in utilities which are children of this utility in the utility hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedUtilityView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this utility only.
Compliance	`mandatory`		This method is must be implemented.
Method	getMeterQuery
Description	Gets a meter query.
Return	`osid.metering.MeterQuery`		the meter query
Compliance	`mandatory`		This method must be implemented.
Method	getMetersByQuery
Description	Gets a list of meters matching the given meter query.
Parameters	`osid.metering.MeterQuery`	`meterQuery`	the meter query
Return	`osid.metering.MeterList`		the returned `MeterList`
Errors	NULL_ARGUMENT		`meterQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`meterQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.