org.osid.metering

Interface MeterReadingSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface MeterReadingSession
extends OsidSession

This session is used to read meters.

This reading 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 Summary

Methods

Modifier and Type	Method and Description
boolean	canReadMeters() Tests if this user can read meters.
Utility	getUtility() Gets the Utility associated with this session.
Id	getUtilityId() Gets the Utility Id associated with this session.
Reading	readMeter(Id meterId, Id meteredObjectId) Gets the reading of the Meter specified by its Id.
ReadingList	readMeters(Id meterId, IdList meteredObjectIds) Gets a ReadingList corresponding to the given meterdId and metered object list In plenary mode, the returned list contains all of the readings 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.
void	useComparativeMeterView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedUtilityView() Federates the view for methods in this session.
void	useIsolatedUtilityView() Isolates the view for methods in this session.
void	usePlenaryMeterView() A complete view of the returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getUtilityId

Id getUtilityId()

Gets the Utility Id associated with this session.

Returns:

the Utility Id associated with this session

Compliance:

mandatory - This method must be implemented.

getUtility

Utility getUtility()
                   throws OperationFailedException,
                          PermissionDeniedException

Gets the Utility associated with this session.

Returns:

the utility

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canReadMeters

boolean canReadMeters()

Tests if this user can read 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 metering operations.

Returns:

false if metering methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeMeterView

void useComparativeMeterView()

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.

usePlenaryMeterView

void usePlenaryMeterView()

A complete view of the 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.

useFederatedUtilityView

void useFederatedUtilityView()

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.

useIsolatedUtilityView

void useIsolatedUtilityView()

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.

readMeter

Reading readMeter(Id meterId,
                Id meteredObjectId)
                  throws NotFoundException,
                         OperationFailedException,
                         PermissionDeniedException

Gets the reading of 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:

meterId - the Id of the Meter to retrieve

meteredObjectId - the Id of the Metered to retrieve

Returns:

the meter reading

Throws:

NotFoundException - no Meter found with the given Id

NullArgumentException - meterId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

readMeters

ReadingList readMeters(Id meterId,
                     IdList meteredObjectIds)
                       throws NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Gets a ReadingList corresponding to the given meterdId and metered object list In plenary mode, the returned list contains all of the readings 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 readings may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

meterId - the Id of the Meter to retrieve

meteredObjectIds - the Ids of the metered objects to retrieve

Returns:

the returned Reading list

Throws:

NotFoundException - meterId or an Id was not found

NullArgumentException - meterI d or meteredObjectIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.