OSID Logo
OSID Specifications
financials batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.batch.AccountBatchAdminSession
Implementsosid.financials.AccountAdminSession
Description

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.

MethodgetAccountFormsForCreate
Description

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

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]accountRecordTypesarray of account record types to be included in each create operation or an empty list if none
Returnosid.financials.batch.AccountBatchFormListthe account forms
ErrorsNULL_ARGUMENT accountRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateAccounts
Description

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 .

Parametersosid.financials.batch.AccountBatchFormListaccountFormsthe account forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT accountForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAccountFormsForUpdate
Description

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

Parametersosid.id.IdListaccountIdsthe Ids of the Account
Returnosid.financials.batch.AccountBatchFormListthe account form
ErrorsNOT_FOUNDan accountId is not found
NULL_ARGUMENT accountIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAccounts
Description

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 .

Parametersosid.financials.batch.AccountBatchFormListaccountFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT accountForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllAccounts
Description

Deletes all Accounts in this Business .

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

Deletes accounts for the given Ids.

Parametersosid.id.IdListaccountIdsthe Ids of the accounts to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT accountIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasAccounts
Description

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.

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.