| Interface | osid.financials.budgeting.batch.BudgetEntryBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.financials.budgeting.BudgetEntryAdminSession | ||
| Description | 
                 This session creates, updates, and deletes   Create and update operations differ in their usage. To 
                create a   The   Once a batch of   For updates,   Once a batch of   The delete operations delete   | ||
| Method | getBudgetEntryFormsForCreate | ||
| Description | 
                     Gets the budget entry forms for creating a bunch of new budgets. A form is returned for each supplied budget and account pair.  | ||
| Parameters | osid.financials.budgeting.batch.BudgetEntryPeerList | peers | a list of budgets and accounts | 
osid.type.Type[] | budgetRecordTypes | array of budget entry record types to be included in each create operation or an empty list if none | |
| Return | osid.financials.budgeting.batch.BudgetEntryBatchFormList | the budget entry forms | |
| Errors | NOT_FOUND | a  budgetId  or  accountId  is not found  |                 |
| NULL_ARGUMENT |  peers  or  budgetRecordTypes  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 | createBudgetEntries | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.financials.budgeting.batch.BudgetEntryBatchFormList | budgetEntryForms | the budget entry forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  budgetEntryForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getBudgetEntryFormsForUpdate | ||
| Description | 
                     Gets the budget entry forms for updating an existing set of budgets. A new budget entry form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | budgetEntryIds | the  Ids  of the  BudgetEntry   | 
| Return | osid.financials.budgeting.batch.BudgetEntryBatchFormList | the budget entry form | |
| Errors | NOT_FOUND | a  budgetEntryId  is not found  |                 |
| NULL_ARGUMENT |  budgetEntryIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateBudgetEntries | ||
| Description | 
                     Updates existing budgets. 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.budgeting.batch.BudgetEntryBatchFormList | budgetEntryForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  budgetEntryForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllBudgetEntries | ||
| 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 | deleteBudgetEntries | ||
| Description | 
                     Deletes budget entries for the given   | ||
| Parameters | osid.id.IdList | budgetEntryIds | the  Ids  of the budget entries to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  budgetEntryIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteBudgetEntriesForBudget | ||
| Description | 
                     Deletes budget entries for the given budget.  | ||
| Parameters | osid.id.Id | budgetId | the  Id  of a budget  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  budgetId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteBudgetEntriesForAccount | ||
| Description | 
                     Deletes budget entries for the given account  | ||
| Parameters | osid.id.Id | accountId | the  Id  of an account  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  accountId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveBudgetEntriesByDate | ||
| Description | 
                     Deletes budget entries expired before the given date.  | ||
| Parameters | osid.calendaring.DateTime | date | a date | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  date  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasBudgetEntries | ||
| 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. | |