| Interface | osid.financials.batch.AccountBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.financials.AccountAdminSession | ||
| Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an The Once a batch of For updates, Once a batch of The delete operations delete | ||
| Method | getAccountFormsForCreate | ||
| Description |
Gets the account forms for creating a bunch of new accounts. | ||
| Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | accountRecordTypes | array of account record types to be included in each create operation or an empty list if none | |
| Return | osid.financials.batch.AccountBatchFormList | the account forms | |
| Errors | NULL_ARGUMENT | accountRecordTypes is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | unable to request forms with given record types | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | createAccounts | ||
| Description |
Creates a new set of | ||
| Parameters | osid.financials.batch.AccountBatchFormList | accountForms | the account forms |
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT | accountForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAccountFormsForUpdate | ||
| Description |
Gets the account forms for updating an existing set of accounts. A new account form should be requested for each update transaction. | ||
| Parameters | osid.id.IdList | accountIds | the Ids of the Account |
| Return | osid.financials.batch.AccountBatchFormList | the account form | |
| Errors | NOT_FOUND | an accountId is not found | |
| NULL_ARGUMENT | accountIds is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateAccounts | ||
| 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 | ||
| Parameters | osid.financials.batch.AccountBatchFormList | accountForms | the form containing the elements to be updated |
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT | accountForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllAccounts | ||
| Description |
Deletes all | ||
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAccounts | ||
| Description |
Deletes accounts for the given | ||
| Parameters | osid.id.IdList | accountIds | the Ids of the accounts to delete |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | accountIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasAccounts | ||
| Description |
Adds an | ||
| Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
| Return | osid.transaction.batch.AliasResponseList | the alias responses | |
| Errors | NULL_ARGUMENT | aliasRequests is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |