Interface MeterUtilitySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface MeterUtilitySession
extends OsidSession

This session provides methods to retrieve Meter to Utility mappings. A Meter may appear in multiple Utility objects. Each catalog may have its own authorizations governing who is allowed to look at it.

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

Method Summary

Modifier and Type	Method	Description
boolean	canLookupMeterUtilityMappings()	Tests if this user can perform lookups of meter/utility mappings.
IdList	getMeterIdsByUtilities(IdList utilityIds)	Gets the list of Meter Ids corresponding to a list of Utility objects.
IdList	getMeterIdsByUtility(Id utilityId)	Gets the list of Meter Ids associated with a Utility .
MeterList	getMetersByUtilities(IdList utilityIds)	Gets the list of Meters corresponding to a list of Utility objects.
MeterList	getMetersByUtility(Id utilityId)	Gets the list of Meters associated with a Utility .
UtilityList	getUtilitiesByMeter(Id meterId)	Gets the Utility objects mapped to a Meter .
IdList	getUtilityIdsByMeter(Id meterId)	Gets the Utility Ids mapped to a Meter .
void	useComparativeUtilityView()	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	usePlenaryUtilityView()	A complete view of the Meter and Utility returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupMeterUtilityMappings

boolean canLookupMeterUtilityMappings()

Tests if this user can perform lookups of meter/utility mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeUtilityView

void useComparativeUtilityView()

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.

usePlenaryUtilityView

void usePlenaryUtilityView()

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

getMeterIdsByUtility

IdList getMeterIdsByUtility(Id utilityId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Meter Ids associated with a Utility .

Parameters:

utilityId - Id of the Utility

Returns:

list of related meter Ids

Throws:

NotFoundException - utilityId is not found

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMetersByUtility

MeterList getMetersByUtility(Id utilityId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Meters associated with a Utility .

Parameters:

utilityId - Id of the Utility

Returns:

list of related meters

Throws:

NotFoundException - utilityId is not found

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMeterIdsByUtilities

IdList getMeterIdsByUtilities(IdList utilityIds)
                       throws OperationFailedException,
PermissionDeniedException

Gets the list of Meter Ids corresponding to a list of Utility objects.

Parameters:

utilityIds - list of utility Ids

Returns:

list of meter Ids

Throws:

NullArgumentException - utilityIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMetersByUtilities

MeterList getMetersByUtilities(IdList utilityIds)
                        throws OperationFailedException,
PermissionDeniedException

Gets the list of Meters corresponding to a list of Utility objects.

Parameters:

utilityIds - list of utility Ids

Returns:

list of meters

Throws:

NullArgumentException - utilityIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getUtilityIdsByMeter

IdList getUtilityIdsByMeter(Id meterId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Utility Ids mapped to a Meter .

Parameters:

meterId - Id of a Meter

Returns:

list of utility Ids

Throws:

NotFoundException - meterId is not found

NullArgumentException - meterId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getUtilitiesByMeter

UtilityList getUtilitiesByMeter(Id meterId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Utility objects mapped to a Meter .

Parameters:

meterId - Id of a Meter

Returns:

list of utility Ids

Throws:

NotFoundException - meterId is not found

NullArgumentException - meterId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.