public interface FiscalPeriodBatchAdminSession extends FiscalPeriodAdminSession
This session creates, updates, and deletes FiscalPeriods
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
FiscalPeriod,
a FiscalPeriodForm
is requested using
getFiscalPeriodFormsForCreate()
specifying the desired
record Types
or none if no record Types
are
needed. Each of the returned FiscalPeriodForms
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
FiscalPeriodForm
is submiited to a create operation, it cannot be
reused with another create operation unless the first operation was
unsuccessful. Each FiscalPeriodForm
corresponds to an
attempted transaction.
The FiscalPeriodForms
returned from
getFiscalPeriodFormsForCreate()
may be linked to the originating
request through the peer Ids
of the
FiscalPeriodForm.
In the case where there may be duplicates, any
FiscalPeriodForm
of the same peer Ids
may be
used for a create operation.
Once a batch of FiscalPeriodForms
are submitted for
create, a CreateResponse
is returned for each
FiscalPeriodForm,
although the ordering is not defined. Only
errors that pertain to the entire create operation are returned from
createFiscalPeriods(),
errors specific to an individual
FiscalPeriodForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating FiscalPeriodForm
through the
FiscalPeriodForm
Id
.
For updates, FiscalPeriodForms
are requested to the
FiscalPeriod
Id
that is to be updated using
getFiscalPeriodFormsForUpdate()
where the reference
Id
in the FiscalPeriodForm
may be used to link the
request. Similarly, the FiscalPeriodForm
has metadata about
the data that can be updated and it can perform validation before
submitting the update. The FiscalPeriodForm
can only be
used once for a successful update and cannot be reused.
Once a batch of FiscalPeriodForms
are submitted for
update, an UpdateResponse
is returned for each
FiscalPeriodForm,
although the ordering is not defined. Only
errors that pertain to the entire update operation are returned from
updateFiscalPeriods(),
errors specific to an individual
FiscalPeriodForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating FiscalPeriodForm
through the
FiscalPeriodForm
Id.
The delete operations delete FiscalPeriods
in bulk. To
unmap a FiscalPeriod
from the current Business,
the FiscalPeriodBusinessAssignmentSession
should be
used. These delete operations attempt to remove the FiscalPeriod
itself thus removing it from all known Business
catalogs. Bulk delete operations return the results in
DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasFiscalPeriods(AliasRequestList aliasRequests)
Adds an
Id to a FiscalPeriod for the
purpose of creating compatibility. |
CreateResponseList |
createFiscalPeriods(FiscalPeriodBatchFormList fiscalPeriodForms)
Creates a new set of
FiscalPeriods. |
DeleteResponseList |
deleteAllFiscalPeriods()
Deletes all
FiscalPeriods in this Business
. |
DeleteResponseList |
deleteFiscalPeriods(IdList fiscalPeriodIds)
Deletes fiscal periods for the given
Ids. |
DeleteResponseList |
deleteFiscalPeriodsByDate(DateTime date)
Deletes fiscal periods containing the given date.
|
FiscalPeriodBatchFormList |
getFiscalPeriodFormsForCreate(long number,
Type[] fiscalPeriodRecordTypes)
Gets the fiscal period forms for creating a bunch of new fiscal
periods.
|
FiscalPeriodBatchFormList |
getFiscalPeriodFormsForUpdate(IdList fiscalPeriodIds)
Gets the fiscal period forms for updating an existing set of fiscal
periods.
|
UpdateResponseList |
updateFiscalPeriods(FiscalPeriodBatchFormList fiscalPeriodForms)
Updates existing fiscal periods.
|
aliasFiscalPeriod, canCreateFiscalPeriods, canCreateFiscalPeriodWithRecordTypes, canDeleteFiscalPeriods, canManageFiscalPeriodAliases, canUpdateFiscalPeriods, createFiscalPeriod, deleteFiscalPeriod, getBusiness, getBusinessId, getFiscalPeriodFormForCreate, getFiscalPeriodFormForUpdate, updateFiscalPeriod
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
FiscalPeriodBatchFormList getFiscalPeriodFormsForCreate(long number, Type[] fiscalPeriodRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievefiscalPeriodRecordTypes
- array of fiscal period record types to
be included in each create operation or an empty list if noneNullArgumentException
- fiscalPeriodRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createFiscalPeriods(FiscalPeriodBatchFormList fiscalPeriodForms) throws OperationFailedException, PermissionDeniedException
FiscalPeriods.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.fiscalPeriodForms
- the fiscal period formsNullArgumentException
- fiscalPeriodForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FiscalPeriodBatchFormList getFiscalPeriodFormsForUpdate(IdList fiscalPeriodIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
fiscalPeriodIds
- the Ids
of the
FiscalPeriod
NotFoundException
- a fiscalPeriodId
is
not foundNullArgumentException
- fiscalPeriodIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateFiscalPeriods(FiscalPeriodBatchFormList fiscalPeriodForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.fiscalPeriodForms
- the form containing the elements to be
updatedNullArgumentException
- fiscalPeriodForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllFiscalPeriods() throws OperationFailedException, PermissionDeniedException
FiscalPeriods
in this Business
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteFiscalPeriods(IdList fiscalPeriodIds) throws OperationFailedException, PermissionDeniedException
Ids.
fiscalPeriodIds
- the Ids
of the fiscal periods
to deleteNullArgumentException
- fiscalPeriodIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteFiscalPeriodsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasFiscalPeriods(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a FiscalPeriod
for the
purpose of creating compatibility. The primary Id
of
the FiscalPeriod
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another fiscal period, it is reassigned to the
given fiscal period Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.