org.osid.acknowledgement.batch

Interface BillingBatchAdminSession

All Superinterfaces:

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

public interface BillingBatchAdminSession
extends BillingAdminSession

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

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

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

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

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

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

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasBillings(AliasRequestList aliasRequests) Adds an Id to an Billing for the purpose of creating compatibility.
CreateResponseList	createBillings(BillingBatchFormList billingForms) Creates a new set of Billings.
DeleteResponseList	deleteAllBillings() Deletes all Billings.
DeleteResponseList	deleteBillings(IdList billingIds) Deletes billings for the given Ids.
BillingBatchFormList	getBillingFormsForCreate(long number, Type[] billingRecordTypes) Gets the billing forms for creating a bunch of new billings.
BillingBatchFormList	getBillingFormsForUpdate(IdList billingIds) Gets the billing forms for updating an existing set of billings.
UpdateResponseList	updateBillings(BillingBatchFormList billingForms) Updates existing billings.

Methods inherited from interface org.osid.acknowledgement.BillingAdminSession

aliasBilling, canCreateBillings, canCreateBillingWithRecordTypes, canDeleteBillings, canManageBillingAliases, canUpdateBillings, createBilling, deleteBilling, getBillingFormForCreate, getBillingFormForUpdate, updateBilling

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

getBillingFormsForCreate

BillingBatchFormList getBillingFormsForCreate(long number,
                                            Type[] billingRecordTypes)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets the billing forms for creating a bunch of new billings.

Parameters:

number - the number of forms to retrieve

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

Returns:

the billing forms

Throws:

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

createBillings

CreateResponseList createBillings(BillingBatchFormList billingForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

billingForms - the billing forms

Returns:

the create responses

Throws:

NullArgumentException - billingForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBillingFormsForUpdate

BillingBatchFormList getBillingFormsForUpdate(IdList billingIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

billingIds - the Ids of the Billing

Returns:

the billing form

Throws:

NotFoundException - a billingId is not found

NullArgumentException - billingIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateBillings

UpdateResponseList updateBillings(BillingBatchFormList billingForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

billingForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - billingForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllBillings

DeleteResponseList deleteAllBillings()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Billings.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteBillings

DeleteResponseList deleteBillings(IdList billingIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes billings for the given Ids.

Parameters:

billingIds - the Ids of the billings to delete

Returns:

the delete responses

Throws:

NullArgumentException - billingIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasBillings

AliasResponseList aliasBillings(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

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