org.osid.financials.batch

Interface AccountBatchAdminSession

All Superinterfaces:

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

public interface AccountBatchAdminSession
extends AccountAdminSession

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

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

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

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

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

The delete operations delete Accounts in bulk. To unmap an Account from the current Business, the AccountBusinessAssignmentSession should be used. These delete operations attempt to remove the Account 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	aliasAccounts(AliasRequestList aliasRequests) Adds an Id to an Account for the purpose of creating compatibility.
CreateResponseList	createAccounts(AccountBatchFormList accountForms) Creates a new set of Accounts.
DeleteResponseList	deleteAccounts(IdList accountIds) Deletes accounts for the given Ids.
DeleteResponseList	deleteAllAccounts() Deletes all Accounts in this Business .
AccountBatchFormList	getAccountFormsForCreate(long number, Type[] accountRecordTypes) Gets the account forms for creating a bunch of new accounts.
AccountBatchFormList	getAccountFormsForUpdate(IdList accountIds) Gets the account forms for updating an existing set of accounts.
UpdateResponseList	updateAccounts(AccountBatchFormList accountForms) Updates existing accounts.

Methods inherited from interface org.osid.financials.AccountAdminSession

aliasAccount, canCreateAccounts, canCreateAccountWithRecordTypes, canDeleteAccounts, canManageAccountAliases, canUpdateAccounts, createAccount, deleteAccount, getAccountFormForCreate, getAccountFormForUpdate, getBusiness, getBusinessId, updateAccount

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

getAccountFormsForCreate

AccountBatchFormList getAccountFormsForCreate(long number,
                                            Type[] accountRecordTypes)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets the account forms for creating a bunch of new accounts.

Parameters:

number - the number of forms to retrieve

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

Returns:

the account forms

Throws:

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

createAccounts

CreateResponseList createAccounts(AccountBatchFormList accountForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

accountForms - the account forms

Returns:

the create responses

Throws:

NullArgumentException - accountForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAccountFormsForUpdate

AccountBatchFormList getAccountFormsForUpdate(IdList accountIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

accountIds - the Ids of the Account

Returns:

the account form

Throws:

NotFoundException - an accountId is not found

NullArgumentException - accountIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateAccounts

UpdateResponseList updateAccounts(AccountBatchFormList accountForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

accountForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - accountForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllAccounts

DeleteResponseList deleteAllAccounts()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Accounts in this Business .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAccounts

DeleteResponseList deleteAccounts(IdList accountIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes accounts for the given Ids.

Parameters:

accountIds - the Ids of the accounts to delete

Returns:

the delete responses

Throws:

NullArgumentException - accountIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasAccounts

AliasResponseList aliasAccounts(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

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