OSID Logo
OSID Specifications
financials budgeting batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.budgeting.batch.BudgetEntryBatchAdminSession
Implementsosid.financials.budgeting.BudgetEntryAdminSession
Description

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.

MethodgetBudgetEntryFormsForCreate
Description

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

Parametersosid.financials.budgeting.batch.BudgetEntryPeerListpeersa list of budgets and accounts
osid.type.Type[]budgetRecordTypesarray of budget entry record types to be included in each create operation or an empty list if none
Returnosid.financials.budgeting.batch.BudgetEntryBatchFormListthe budget entry forms
ErrorsNOT_FOUNDa budgetId or accountId is not found
NULL_ARGUMENT peers or budgetRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateBudgetEntries
Description

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 .

Parametersosid.financials.budgeting.batch.BudgetEntryBatchFormListbudgetEntryFormsthe budget entry forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT budgetEntryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntryFormsForUpdate
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.

Parametersosid.id.IdListbudgetEntryIdsthe Ids of the BudgetEntry
Returnosid.financials.budgeting.batch.BudgetEntryBatchFormListthe budget entry form
ErrorsNOT_FOUNDa budgetEntryId is not found
NULL_ARGUMENT budgetEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateBudgetEntries
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 BatchCreateResponse .

Parametersosid.financials.budgeting.batch.BudgetEntryBatchFormListbudgetEntryFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT budgetEntryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllBudgetEntries
Description

Deletes all BudgetEntries in this Business .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteBudgetEntries
Description

Deletes budget entries for the given Ids.

Parametersosid.id.IdListbudgetEntryIdsthe Ids of the budget entries to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT budgetEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteBudgetEntriesForBudget
Description

Deletes budget entries for the given budget.

Parametersosid.id.IdbudgetIdthe Id of a budget
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT budgetId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteBudgetEntriesForAccount
Description

Deletes budget entries for the given account

Parametersosid.id.IdaccountIdthe Id of an account
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveBudgetEntriesByDate
Description

Deletes budget entries expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasBudgetEntries
Description

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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.