org.osid.metering.batch

Interface MeterBatchAdminSession

All Superinterfaces:

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

public interface MeterBatchAdminSession
extends MeterAdminSession

This session creates, updates, and deletes Meters in bulk. 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 getMeterFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned MeterForms 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 a 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.

The MeterForms returned from getMeterFormsForCreate() may be linked to the originating request through the peer Ids of the MeterForm. In the case where there may be duplicates, any MeterForm of the same peer Ids may be used for a create operation.

Once a batch of MeterForms are submitted for create, a CreateResponse is returned for each MeterForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createMeters(), errors specific to an individual MeterForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating MeterForm through the MeterForm Id .

For updates, MeterForms are requested to the Meter Id that is to be updated using getMeterFormsForUpdate() where the reference Id in the MeterForm may be used to link the request. 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.

Once a batch of MeterForms are submitted for update, an UpdateResponse is returned for each MeterForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateMeters(), errors specific to an individual MeterForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating MeterForm through the MeterForm Id.

The delete operations delete Meters in bulk. 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. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasMeters(AliasRequestList aliasRequests) Adds an Id to a Meter for the purpose of creating compatibility.
CreateResponseList	createMeters(MeterBatchFormList meterForms) Creates a new set of Meters.
DeleteResponseList	deleteAllMeters() Deletes all Meters in this Utility .
DeleteResponseList	deleteMeters(IdList meterIds) Deletes meters for the given Ids.
MeterBatchFormList	getMeterFormsForCreate(long number, Type[] meterRecordTypes) Gets the meter forms for creating a bunch of new meters.
MeterBatchFormList	getMeterFormsForUpdate(IdList meterIds) Gets the meter forms for updating an existing set of meters.
UpdateResponseList	updateMeters(MeterBatchFormList meterForms) Updates existing meters.

Methods inherited from interface org.osid.metering.MeterAdminSession

aliasMeter, canCreateMeters, canCreateMeterWithRecordTypes, canDeleteMeters, canManageMeterAliases, canUpdateMeters, createMeter, deleteMeter, getMeterFormForCreate, getMeterFormForUpdate, getUtility, getUtilityId, updateMeter

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

getMeterFormsForCreate

MeterBatchFormList getMeterFormsForCreate(long number,
                                        Type[] meterRecordTypes)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets the meter forms for creating a bunch of new meters.

Parameters:

number - the number of forms to retrieve

meterRecordTypes - array of meter record types to be included in each create operation or an empty list if none

Returns:

the meter forms

Throws:

NullArgumentException - meterRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createMeters

CreateResponseList createMeters(MeterBatchFormList meterForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

Creates a new set of Meters. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

meterForms - the meter forms

Returns:

the create responses

Throws:

NullArgumentException - meterForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMeterFormsForUpdate

MeterBatchFormList getMeterFormsForUpdate(IdList meterIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

meterIds - the Ids of the Meter

Returns:

the meter form

Throws:

NotFoundException - a meterId is not found

NullArgumentException - meterIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateMeters

UpdateResponseList updateMeters(MeterBatchFormList meterForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

Updates existing meters. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

meterForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - meterForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllMeters

DeleteResponseList deleteAllMeters()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Meters in this Utility .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteMeters

DeleteResponseList deleteMeters(IdList meterIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Deletes meters for the given Ids.

Parameters:

meterIds - the Ids of the meters to delete

Returns:

the delete responses

Throws:

NullArgumentException - meterIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasMeters

AliasResponseList aliasMeters(AliasRequestList aliasRequests)
                              throws 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 is an alias to the primary Id. If the alias is a pointer to another meter, it is reassigned to the given meter Id.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.