OSID Logo
OSID Specifications
metering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.batch.UtilityBatchAdminSession
Implementsosid.metering.UtilityAdminSession
Description

This session creates, updates, and deletes Utilities 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 Utility, a UtilityForm is requested using getUtilityFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned UtilityForms 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 UtilityForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each UtilityForm corresponds to an attempted transaction.

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

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

For updates, UtilityForms are requested to the Utility Id that is to be updated using getUtilityFormsForUpdate() where the reference Id in the UtilityForm may be used to link the request. Similarly, the UtilityForm has metadata about the data that can be updated and it can perform validation before submitting the update. The UtilityForm can only be used once for a successful update and cannot be reused.

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

The delete operations delete Utilities in bulk. Bulk delete operations return the results in DeleteResponses.

MethodgetUtilityFormsForCreate
Description

Gets the utility forms for creating a bunch of new utilities.

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

Creates a new set of Utilities. 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.UtilityBatchFormListutilityFormsthe utility forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT utilityForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetUtilityFormsForUpdate
Description

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

Parametersosid.id.IdListutilityIdsthe Ids of the Utility
Returnosid.metering.batch.UtilityBatchFormListthe utility form
ErrorsNOT_FOUNDa utilityId is not found
NULL_ARGUMENT utilityIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateUtilities
Description

Updates existing utilities. 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.UtilityBatchFormListutilityFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT utilityForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllUtilities
Description

Deletes all Utilities.

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

Deletes utilities for the given Ids.

Parametersosid.id.IdListutilityIdsthe Ids of the utilities to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT utilityIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasUtilities
Description

Adds an Id to a Utility for the purpose of creating compatibility. The primary Id of the Utility is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another utility, it is reassigned to the given utility 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.