OSID Logo
OSID Specifications
metering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.batch.MeterBatchAdminSession
Implementsosid.metering.MeterAdminSession
Description

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.

MethodgetMeterFormsForCreate
Description

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

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]meterRecordTypesarray of meter record types to be included in each create operation or an empty list if none
Returnosid.metering.batch.MeterBatchFormListthe meter forms
ErrorsNULL_ARGUMENT meterRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateMeters
Description

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 .

Parametersosid.metering.batch.MeterBatchFormListmeterFormsthe meter forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT meterForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMeterFormsForUpdate
Description

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

Parametersosid.id.IdListmeterIdsthe Ids of the Meter
Returnosid.metering.batch.MeterBatchFormListthe meter form
ErrorsNOT_FOUNDa meterId is not found
NULL_ARGUMENT meterIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateMeters
Description

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 .

Parametersosid.metering.batch.MeterBatchFormListmeterFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT meterForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllMeters
Description

Deletes all Meters in this Utility .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteMeters
Description

Deletes meters for the given Ids.

Parametersosid.id.IdListmeterIdsthe Ids of the meters to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT meterIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasMeters
Description

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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.