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.
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.
|
aliasBudgetEntry, canCreateBudgetEntries, canCreateBudgetEntryWithRecordTypes, canDeleteBudgetEntries, canManageBudgetEntryAliases, canUpdateBudgetEntries, createBudgetEntry, deleteBudgetEntry, getBudgetEntryFormForCreate, getBudgetEntryFormForUpdate, getBusiness, getBusinessId, updateBudgetEntry
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BudgetEntryBatchFormList getBudgetEntryFormsForCreate(BudgetEntryPeerList peers, Type[] budgetRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- a list of budgets and accountsbudgetRecordTypes
- array of budget entry record types to be
included in each create operation or an empty list if noneNotFoundException
- a budgetId
or
accountId
is not foundNullArgumentException
- peers
or
budgetRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createBudgetEntries(BudgetEntryBatchFormList budgetEntryForms) throws OperationFailedException, PermissionDeniedException
BudgetEntries.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.budgetEntryForms
- the budget entry formsNullArgumentException
- budgetEntryForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetEntryBatchFormList getBudgetEntryFormsForUpdate(IdList budgetEntryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
budgetEntryIds
- the Ids
of the
BudgetEntry
NotFoundException
- a budgetEntryId
is
not foundNullArgumentException
- budgetEntryIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateBudgetEntries(BudgetEntryBatchFormList budgetEntryForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.budgetEntryForms
- the form containing the elements to be
updatedNullArgumentException
- budgetEntryForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllBudgetEntries() throws OperationFailedException, PermissionDeniedException
BudgetEntries
in this Business
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteBudgetEntries(IdList budgetEntryIds) throws OperationFailedException, PermissionDeniedException
Ids.
budgetEntryIds
- the Ids
of the budget entries to
deleteNullArgumentException
- budgetEntryIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteBudgetEntriesForBudget(Id budgetId) throws OperationFailedException, PermissionDeniedException
budgetId
- the Id
of a budgetNullArgumentException
- budgetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteBudgetEntriesForAccount(Id accountId) throws OperationFailedException, PermissionDeniedException
accountId
- the Id
of an accountNullArgumentException
- accountId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveBudgetEntriesByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasBudgetEntries(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.