OSID Logo
OSID Specifications
assessment batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.batch.BankBatchAdminSession
Implementsosid.assessment.BankAdminSession
Description

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

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

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

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

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

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

MethodgetBankFormsForCreate
Description

Gets the bank forms for creating a bunch of new banks.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]bankRecordTypesarray of bank record types to be included in each create operation or an empty list if none
Returnosid.assessment.batch.BankBatchFormListthe bank forms
ErrorsNULL_ARGUMENT bankRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateBanks
Description

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

Parametersosid.assessment.batch.BankBatchFormListbankFormsthe bank forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT bankForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBankFormsForUpdate
Description

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

Parametersosid.id.IdListbankIdsthe Ids of the Bank
Returnosid.assessment.batch.BankBatchFormListthe bank form
ErrorsNOT_FOUNDa bankId is not found
NULL_ARGUMENT bankIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateBanks
Description

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

Parametersosid.assessment.batch.BankBatchFormListbankFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT bankForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllBanks
Description

Deletes all Banks.

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

Deletes banks for the given Ids.

Parametersosid.id.IdListbankIdsthe Ids of the banks to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT bankIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasBanks
Description

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