Interface FiscalPeriodBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, FiscalPeriodAdminSession, OsidSession, OsidSession
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 .