org.osid.metering.batch

Interface UtilityBatchAdminSession

All Superinterfaces:

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

public interface UtilityBatchAdminSession
extends UtilityAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasUtilities(AliasRequestList aliasRequests) Adds an Id to a Utility for the purpose of creating compatibility.
CreateResponseList	createUtilities(UtilityBatchFormList utilityForms) Creates a new set of Utilities.
DeleteResponseList	deleteAllUtilities() Deletes all Utilities.
DeleteResponseList	deleteUtilities(IdList utilityIds) Deletes utilities for the given Ids.
UtilityBatchFormList	getUtilityFormsForCreate(long number, Type[] utilityRecordTypes) Gets the utility forms for creating a bunch of new utilities.
UtilityBatchFormList	getUtilityFormsForUpdate(IdList utilityIds) Gets the utility forms for updating an existing set of utilities.
UpdateResponseList	updateUtilities(UtilityBatchFormList utilityForms) Updates existing utilities.

Methods inherited from interface org.osid.metering.UtilityAdminSession

aliasUtility, canCreateUtilities, canCreateUtilityWithRecordTypes, canDeleteUtilities, canManageUtilityAliases, canUpdateUtilities, createUtility, deleteUtility, getUtilityFormForCreate, getUtilityFormForUpdate, updateUtility

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

getUtilityFormsForCreate

UtilityBatchFormList getUtilityFormsForCreate(long number,
                                            Type[] utilityRecordTypes)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

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

Returns:

the utility forms

Throws:

NullArgumentException - utilityRecordTypes 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.

createUtilities

CreateResponseList createUtilities(UtilityBatchFormList utilityForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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 .

Parameters:

utilityForms - the utility forms

Returns:

the create responses

Throws:

NullArgumentException - utilityForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getUtilityFormsForUpdate

UtilityBatchFormList getUtilityFormsForUpdate(IdList utilityIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

utilityIds - the Ids of the Utility

Returns:

the utility form

Throws:

NotFoundException - a utilityId is not found

NullArgumentException - utilityIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateUtilities

UpdateResponseList updateUtilities(UtilityBatchFormList utilityForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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 .

Parameters:

utilityForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - utilityForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllUtilities

DeleteResponseList deleteAllUtilities()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes all Utilities.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteUtilities

DeleteResponseList deleteUtilities(IdList utilityIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes utilities for the given Ids.

Parameters:

utilityIds - the Ids of the utilities to delete

Returns:

the delete responses

Throws:

NullArgumentException - utilityIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasUtilities

AliasResponseList aliasUtilities(AliasRequestList aliasRequests)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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.

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.