OSID - osid.metering.MeterLookupSession Service Interface Definition

Interface	osid.metering.MeterLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving meters. A `Meter` represents a statistic. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition federated utility view: includes meters in utilities which are children of this utility in the utility hierarchy isolated utility view: restricts lookups to 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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupMeters
Description	Tests if this user can lookup meters. 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 reading operations.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeMeterView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryMeterView
Description	A complete view of the `Meter` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is 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 retrievals to this utility only.
Compliance	`mandatory`		This method is must be implemented.
Method	getMeter
Description	Gets the `Meter` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Meter` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Meter` and retained for compatibility.
Parameters	`osid.id.Id`	`meterId`	the `Id` of the `Meter` to retrieve
Return	`osid.metering.Meter`		the returned `Meter`
Errors	NOT_FOUND		no `Meter` found with the given `Id`
	NULL_ARGUMENT		`meterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMetersByIds
Description	Gets a `MeterList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the meters specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible meters may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`meterIds`	the list of `Ids` to retrieve
Return	`osid.metering.MeterList`		the returned `Meter list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`meterIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMetersByGenusType
Description	Gets a `MeterList` corresponding to the given meter genus `Type` which does not include meters of types derived from the specified `Type.` In plenary mode, the returned list contains all known meters or an error results. Otherwise, the returned list may contain only those meters that are accessible through this session.
Parameters	`osid.type.Type`	`meterGenusType`	a meter genus type
Return	`osid.metering.MeterList`		the returned `Meter` list
Errors	NULL_ARGUMENT		`meterGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMetersByParentGenusType
Description	Gets a `MeterList` corresponding to the given meter genus `Type` and include meters of types derived from the specified `Type.` In plenary mode, the returned list contains all known meters or an error results. Otherwise, the returned list may contain only those meters that are accessible through this session.
Parameters	`osid.type.Type`	`meterGenusType`	a meter genus type
Return	`osid.metering.MeterList`		the returned `Meter` list
Errors	NULL_ARGUMENT		`meterGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMetersByRecordType
Description	Gets a `MeterList` containing the given meter record `Type.` In plenary mode, the returned list contains all known meters or an error results. Otherwise, the returned list may contain only those meters that are accessible through this session.
Parameters	`osid.type.Type`	`meterRecordType`	a meter record type
Return	`osid.metering.MeterList`		the returned `Meter` list
Errors	NULL_ARGUMENT		`meterRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMeters
Description	Gets all meters. In plenary mode, the returned list contains all known meters or an error results. Otherwise, the returned list may contain only those meters that are accessible through this session.
Return	`osid.metering.MeterList`		a list of meters
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.