Interface BudgetBatchAdminSession

All Superinterfaces:
AutoCloseable, BudgetAdminSession, Closeable, OsidSession, OsidSession
public interface BudgetBatchAdminSession extends BudgetAdminSession

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

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

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

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

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

The delete operations delete Budgets in bulk. To unmap a Budget from the current Business , the BudgetBusinessAssignmentSession should be used. These delete operations attempt to remove the Budget itself thus removing it from all known Business catalogs. Bulk delete operations return the results in DeleteResponses .