Interface MeterAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

MeterBatchAdminSession

public interface MeterAdminSession
extends OsidSession

This session creates, updates, and deletes Meters . The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Meter , a MeterForm is requested using getMeterFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned MeterForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the MeterForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each MeterForm corresponds to an attempted transaction.

For updates, MeterForms are requested to the Meter Id that is to be updated using getMeterFormForUpdate() . Similarly, the MeterForm has metadata about the data that can be updated and it can perform validation before submitting the update. The MeterForm can only be used once for a successful update and cannot be reused.

The delete operations delete Meters . To unmap a Meter from the current Utility , the MeterUtilityAssignmentSession should be used. These delete operations attempt to remove the Meter itself thus removing it from all known Utility catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

Method Summary

Modifier and Type	Method	Description
void	aliasMeter(Id meterId, Id aliasId)	Adds an Id to a Meter for the purpose of creating compatibility.
boolean	canCreateMeters()	Tests if this user can create Meters A return of true does not guarantee successful authorization.
boolean	canCreateMeterWithRecordTypes(Type[] meterRecordTypes)	Tests if this user can create a single Meter using the desired record types.
boolean	canDeleteMeters()	Tests if this user can delete Meters .
boolean	canManageMeterAliases()	Tests if this user can manage Id aliases for Meters .
boolean	canUpdateMeters()	Tests if this user can update Meters .
Meter	createMeter(MeterForm meterForm)	Creates a new Meter .
void	deleteMeter(Id meterId)	Deletes a Meter .
MeterForm	getMeterFormForCreate(Type[] meterRecordTypes)	Gets the meter form for creating new meters.
MeterForm	getMeterFormForUpdate(Id meterId)	Gets the meter form for updating an existing meter.
Utility	getUtility()	Gets the Utility associated with this session.
Id	getUtilityId()	Gets the Utility Id associated with this session.
void	updateMeter(MeterForm meterForm)	Updates an existing meter.

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

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 associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateMeters

boolean canCreateMeters()

Tests if this user can create Meters A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Meter will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returns:

false if Meter creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateMeterWithRecordTypes

boolean canCreateMeterWithRecordTypes(Type[] meterRecordTypes)

Tests if this user can create a single Meter using the desired record types. While MeteringManager.getMeterRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Meter . Providing an empty array tests if a Meter can be created with no records.

Parameters:

meterRecordTypes - array of meter record types

Returns:

true if Meter creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - meterRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getMeterFormForCreate

MeterForm getMeterFormForCreate(Type[] meterRecordTypes)
                         throws OperationFailedException,
PermissionDeniedException

Gets the meter form for creating new meters. A new form should be requested for each create transaction.

Parameters:

meterRecordTypes - array of meter record types

Returns:

the meter form

Throws:

NullArgumentException - meterRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createMeter

Meter createMeter(MeterForm meterForm)
           throws OperationFailedException,
PermissionDeniedException

Creates a new Meter .

Parameters:

meterForm - the form for this Meter

Returns:

the new Meter

Throws:

IllegalStateException - meterForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - meterForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - meterForm did not originate from getMeterFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateMeters

boolean canUpdateMeters()

Tests if this user can update Meters . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Meter will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returns:

false if Meter modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getMeterFormForUpdate

MeterForm getMeterFormForUpdate(Id meterId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the meter form for updating an existing meter. A new meter form should be requested for each update transaction.

Parameters:

meterId - the Id of the Meter

Returns:

the meter form

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.

updateMeter

void updateMeter(MeterForm meterForm)
          throws OperationFailedException,
PermissionDeniedException

Updates an existing meter.

Parameters:

meterForm - the form containing the elements to be updated

Throws:

IllegalStateException - meterForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - meterForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - meterForm did not originate from getMeterFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteMeters

boolean canDeleteMeters()

Tests if this user can delete Meters . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Meter will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returns:

false if Meter deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteMeter

void deleteMeter(Id meterId)
          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes a Meter .

Parameters:

meterId - the Id of the Meter to remove

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.

canManageMeterAliases

boolean canManageMeterAliases()

Tests if this user can manage Id aliases for Meters . A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returns:

false if Meter aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasMeter

void aliasMeter(Id meterId,
 Id aliasId)
         throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an Id to a Meter for the purpose of creating compatibility. The primary Id of the Meter is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another meter, it is reassigned to the given meter Id .

Parameters:

meterId - the Id of a Meter

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - meterId not found

NullArgumentException - meterId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.