org.osid.billing.batch

Interface BusinessBatchAdminSession

All Superinterfaces:

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

public interface BusinessBatchAdminSession
extends BusinessAdminSession

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

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

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

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

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

The delete operations delete Businesses in bulk. To unmap a Business from the current Business, the BusinessBusinessAssignmentSession should be used. These delete operations attempt to remove the Business itself thus removing it from all known Business catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasBusinesses(AliasRequestList aliasRequests) Adds an Id to a Business for the purpose of creating compatibility.
CreateResponseList	createBusinesses(BusinessBatchFormList businessForms) Creates a new set of Businesses.
DeleteResponseList	deleteAllBusinesses() Deletes all Businesses in this Business .
DeleteResponseList	deleteBusinesses(IdList businessIds) Deletes businesses for the given Ids.
BusinessBatchFormList	getBusinessFormsForCreate(long number, Type[] businessRecordTypes) Gets the business forms for creating a bunch of new businesses.
BusinessBatchFormList	getBusinessFormsForUpdate(IdList businessIds) Gets the business forms for updating an existing set of businesses.
UpdateResponseList	updateBusinesses(BusinessBatchFormList businessForms) Updates existing businesses.

Methods inherited from interface org.osid.billing.BusinessAdminSession

aliasBusiness, canCreateBusinesses, canCreateBusinessWithRecordTypes, canDeleteBusinesses, canManageBusinessAliases, canUpdateBusinesses, createBusiness, deleteBusiness, getBusinessFormForCreate, getBusinessFormForUpdate, updateBusiness

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

getBusinessFormsForCreate

BusinessBatchFormList getBusinessFormsForCreate(long number,
                                              Type[] businessRecordTypes)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets the business forms for creating a bunch of new businesses.

Parameters:

number - the number of forms to retrieve

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

Returns:

the business forms

Throws:

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

createBusinesses

CreateResponseList createBusinesses(BusinessBatchFormList businessForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

businessForms - the business forms

Returns:

the create responses

Throws:

NullArgumentException - businessForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessFormsForUpdate

BusinessBatchFormList getBusinessFormsForUpdate(IdList businessIds)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

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

Parameters:

businessIds - the Ids of the Business

Returns:

the business form

Throws:

NotFoundException - a businessId is not found

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateBusinesses

UpdateResponseList updateBusinesses(BusinessBatchFormList businessForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

businessForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - businessForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllBusinesses

DeleteResponseList deleteAllBusinesses()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes all Businesses in this Business .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteBusinesses

DeleteResponseList deleteBusinesses(IdList businessIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes businesses for the given Ids.

Parameters:

businessIds - the Ids of the businesses to delete

Returns:

the delete responses

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasBusinesses

AliasResponseList aliasBusinesses(AliasRequestList aliasRequests)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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