org.osid.financials.budgeting.batch

Interface BudgetBatchAdminSession

All Superinterfaces:

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

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasBudgets(AliasRequestList aliasRequests) Adds an Id to a Budget for the purpose of creating compatibility.
CreateResponseList	createBudgets(BudgetBatchFormList budgetForms) Creates a new set of Budgets.
DeleteResponseList	deleteAllBudgets() Deletes all Budgets in this Business .
DeleteResponseList	deleteBudgets(IdList budgetIds) Deletes budgets for the given Ids.
DeleteResponseList	deleteBudgetsForActivity(Id activityId) Deletes budgets for the given activity.
DeleteResponseList	deleteBudgetsForFiscalPeriod(Id fiscalPeriodId) Deletes budgets for the given fiscal period.
DeleteResponseList	deleteIneffectiveBudgetsByDate(DateTime date) Deletes budgets expired before the given date.
BudgetBatchFormList	getBudgetFormsForCreate(BudgetPeerList peers, Type[] budgetRecordTypes) Gets the budget forms for creating a bunch of new budgets.
BudgetBatchFormList	getBudgetFormsForUpdate(IdList budgetIds) Gets the budget forms for updating an existing set of budgets.
UpdateResponseList	updateBudgets(BudgetBatchFormList budgetForms) Updates existing budgets.

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

aliasBudget, canCreateBudgets, canCreateBudgetWithRecordTypes, canDeleteBudgets, canManageBudgetAliases, canUpdateBudgets, createBudget, deleteBudget, getBudgetFormForCreate, getBudgetFormForUpdate, getBusiness, getBusinessId, updateBudget

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

getBudgetFormsForCreate

BudgetBatchFormList getBudgetFormsForCreate(BudgetPeerList peers,
                                          Type[] budgetRecordTypes)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

peers - a list of activities and fiscal periods

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

Returns:

the budget forms

Throws:

NotFoundException - an activityId or fiscalPeriodId 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.

createBudgets

CreateResponseList createBudgets(BudgetBatchFormList budgetForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

budgetForms - the budget forms

Returns:

the create responses

Throws:

NullArgumentException - budgetForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBudgetFormsForUpdate

BudgetBatchFormList getBudgetFormsForUpdate(IdList budgetIds)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Gets the budget forms for updating an existing set of budgets. A new budget form should be requested for each update transaction.

Parameters:

budgetIds - the Ids of the Budget

Returns:

the budget form

Throws:

NotFoundException - a budgetId is not found

NullArgumentException - budgetIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateBudgets

UpdateResponseList updateBudgets(BudgetBatchFormList budgetForms)
                                 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:

budgetForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - budgetForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllBudgets

DeleteResponseList deleteAllBudgets()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes all Budgets in this Business .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteBudgets

DeleteResponseList deleteBudgets(IdList budgetIds)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes budgets for the given Ids.

Parameters:

budgetIds - the Ids of the budgets to delete

Returns:

the delete responses

Throws:

NullArgumentException - budgetIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteBudgetsForActivity

DeleteResponseList deleteBudgetsForActivity(Id activityId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Deletes budgets for the given activity.

Parameters:

activityId - the Id of an activity

Returns:

the delete responses

Throws:

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteBudgetsForFiscalPeriod

DeleteResponseList deleteBudgetsForFiscalPeriod(Id fiscalPeriodId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Deletes budgets for the given fiscal period.

Parameters:

fiscalPeriodId - the Id of a fiscal period

Returns:

the delete responses

Throws:

NullArgumentException - fiscalPeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveBudgetsByDate

DeleteResponseList deleteIneffectiveBudgetsByDate(DateTime date)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Deletes budgets 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.

aliasBudgets

AliasResponseList aliasBudgets(AliasRequestList aliasRequests)
                               throws OperationFailedException,
                                      PermissionDeniedException

Adds an Id to a Budget for the purpose of creating compatibility. The primary Id of the Budget is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another budget, it is reassigned to the given budget 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.