org.osid.financials.budgeting.batch

Interface BudgetEntryBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, BudgetEntryAdminSession, java.io.Closeable, 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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasBudgetEntries(AliasRequestList aliasRequests) Adds an Id to a BudgetEntry for the purpose of creating compatibility.
CreateResponseList	createBudgetEntries(BudgetEntryBatchFormList budgetEntryForms) Creates a new set of BudgetEntries.
DeleteResponseList	deleteAllBudgetEntries() Deletes all BudgetEntries in this Business .
DeleteResponseList	deleteBudgetEntries(IdList budgetEntryIds) Deletes budget entries for the given Ids.
DeleteResponseList	deleteBudgetEntriesForAccount(Id accountId) Deletes budget entries for the given account
DeleteResponseList	deleteBudgetEntriesForBudget(Id budgetId) Deletes budget entries for the given budget.
DeleteResponseList	deleteIneffectiveBudgetEntriesByDate(DateTime date) Deletes budget entries expired before the given date.
BudgetEntryBatchFormList	getBudgetEntryFormsForCreate(BudgetEntryPeerList peers, Type[] budgetRecordTypes) Gets the budget entry forms for creating a bunch of new budgets.
BudgetEntryBatchFormList	getBudgetEntryFormsForUpdate(IdList budgetEntryIds) Gets the budget entry forms for updating an existing set of budgets.
UpdateResponseList	updateBudgetEntries(BudgetEntryBatchFormList budgetEntryForms) Updates existing budgets.

Methods inherited from interface org.osid.financials.budgeting.BudgetEntryAdminSession

aliasBudgetEntry, canCreateBudgetEntries, canCreateBudgetEntryWithRecordTypes, canDeleteBudgetEntries, canManageBudgetEntryAliases, canUpdateBudgetEntries, createBudgetEntry, deleteBudgetEntry, getBudgetEntryFormForCreate, getBudgetEntryFormForUpdate, getBusiness, getBusinessId, updateBudgetEntry

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getBudgetEntryFormsForCreate

BudgetEntryBatchFormList getBudgetEntryFormsForCreate(BudgetEntryPeerList peers,
                                                    Type[] budgetRecordTypes)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Gets the budget entry forms for creating a bunch of new budgets. A form is returned for each supplied budget and account pair.

Parameters:

peers - a list of budgets and accounts

budgetRecordTypes - array of budget entry record types to be included in each create operation or an empty list if none

Returns:

the budget entry forms

Throws:

NotFoundException - a budgetId or accountId is not found

NullArgumentException - peers or budgetRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createBudgetEntries

CreateResponseList createBudgetEntries(BudgetEntryBatchFormList budgetEntryForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

budgetEntryForms - the budget entry forms

Returns:

the create responses

Throws:

NullArgumentException - budgetEntryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBudgetEntryFormsForUpdate

BudgetEntryBatchFormList getBudgetEntryFormsForUpdate(IdList budgetEntryIds)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

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:

budgetEntryIds - the Ids of the BudgetEntry

Returns:

the budget entry form

Throws:

NotFoundException - a budgetEntryId is not found

NullArgumentException - budgetEntryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateBudgetEntries

UpdateResponseList updateBudgetEntries(BudgetEntryBatchFormList budgetEntryForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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 BatchCreateResponse .

Parameters:

budgetEntryForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - budgetEntryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllBudgetEntries

DeleteResponseList deleteAllBudgetEntries()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes all BudgetEntries in this Business .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteBudgetEntries

DeleteResponseList deleteBudgetEntries(IdList budgetEntryIds)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes budget entries for the given Ids.

Parameters:

budgetEntryIds - the Ids of the budget entries to delete

Returns:

the delete responses

Throws:

NullArgumentException - budgetEntryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteBudgetEntriesForBudget

DeleteResponseList deleteBudgetEntriesForBudget(Id budgetId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Deletes budget entries for the given budget.

Parameters:

budgetId - the Id of a budget

Returns:

the delete responses

Throws:

NullArgumentException - budgetId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteBudgetEntriesForAccount

DeleteResponseList deleteBudgetEntriesForAccount(Id accountId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Deletes budget entries for the given account

Parameters:

accountId - the Id of an account

Returns:

the delete responses

Throws:

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveBudgetEntriesByDate

DeleteResponseList deleteIneffectiveBudgetEntriesByDate(DateTime date)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Deletes budget entries expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasBudgetEntries

AliasResponseList aliasBudgetEntries(AliasRequestList aliasRequests)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Adds an Id to a BudgetEntry for the purpose of creating compatibility. The primary Id of the BudgetEntry is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another budget entry, it is reassigned to the given budget entry Id.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.