Interface MeterBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, MeterAdminSession, OsidSession, 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 .