Interface BudgetEntryBatchAdminSession

All Superinterfaces:
AutoCloseable, BudgetEntryAdminSession, Closeable, OsidSession, OsidSession
public interface BudgetEntryBatchAdminSession extends BudgetEntryAdminSession

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

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

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

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

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

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