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.
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.
|
aliasBudget, canCreateBudgets, canCreateBudgetWithRecordTypes, canDeleteBudgets, canManageBudgetAliases, canUpdateBudgets, createBudget, deleteBudget, getBudgetFormForCreate, getBudgetFormForUpdate, getBusiness, getBusinessId, updateBudget
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BudgetBatchFormList getBudgetFormsForCreate(BudgetPeerList peers, Type[] budgetRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- a list of activities and fiscal periodsbudgetRecordTypes
- array of budget record types to be included
in each create operation or an empty list if noneNotFoundException
- an activityId
or
fiscalPeriodId
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 createBudgets(BudgetBatchFormList budgetForms) throws OperationFailedException, PermissionDeniedException
Budgets.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.budgetForms
- the budget formsNullArgumentException
- budgetForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetBatchFormList getBudgetFormsForUpdate(IdList budgetIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
budgetIds
- the Ids
of the Budget
NotFoundException
- a budgetId
is not
foundNullArgumentException
- budgetIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateBudgets(BudgetBatchFormList budgetForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.budgetForms
- the form containing the elements to be updatedNullArgumentException
- budgetForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllBudgets() throws OperationFailedException, PermissionDeniedException
Budgets
in this Business
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteBudgets(IdList budgetIds) throws OperationFailedException, PermissionDeniedException
Ids.
budgetIds
- the Ids
of the budgets to deleteNullArgumentException
- budgetIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteBudgetsForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
activityId
- the Id
of an activityNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteBudgetsForFiscalPeriod(Id fiscalPeriodId) throws OperationFailedException, PermissionDeniedException
fiscalPeriodId
- the Id
of a fiscal periodNullArgumentException
- fiscalPeriodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveBudgetsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasBudgets(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.