Interface CyclicTimePeriodBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CyclicTimePeriodAdminSession, OsidSession, OsidSession
public interface CyclicTimePeriodBatchAdminSession extends CyclicTimePeriodAdminSession

This session creates, updates, and deletes CyclicTimePeriods 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 CyclicTimePeriod , a CyclicTimePeriodForm is requested using getCyclicTimePeriodFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned CyclicTimePeriodForms 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 CyclicTimePeriodForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each CyclicTimePeriodForm corresponds to an attempted transaction.

The CyclicTimePeriodForms returned from getCyclicTimePeriodFormsForCreate() may be linked to the originating request through the peer Ids of the CyclicTimePeriodForm . In the case where there may be duplicates, any CyclicTimePeriodForm of the same peer Ids may be used for a create operation.

Once a batch of CyclicTimePeriodForms are submitted for create, a CreateResponse is returned for each CyclicTimePeriodForm , although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createCyclicTimePeriods() , errors specific to an individual CyclicTimePeriodForm are indicated in the corresponding CreateResponse . CreateResponses may be linked to the originating CyclicTimePeriodForm through the CyclicTimePeriodForm Id .

For updates, CyclicTimePeriodForms are requested to the CyclicTimePeriod Id that is to be updated using getCyclicTimePeriodFormsForUpdate() where the reference Id in the CyclicTimePeriodForm may be used to link the request. Similarly, the CyclicTimePeriodForm has metadata about the data that can be updated and it can perform validation before submitting the update. The CyclicTimePeriodForm can only be used once for a successful update and cannot be reused.

Once a batch of CyclicTimePeriodForms are submitted for update, an UpdateResponse is returned for each CyclicTimePeriodForm , although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateCyclicTimePeriods() , errors specific to an individual CyclicTimePeriodForm are indicated in the corresponding UpdateResponse . UpdateResponses may be linked to the originating CyclicTimePeriodForm through the CyclicTimePeriodForm Id .

The delete operations delete CyclicTimePeriods in bulk. To unmap a CyclicTimePeriod from the current Calendar , the CyclicTimePeriodCalendarAssignmentSession should be used. These delete operations attempt to remove the CyclicTimePeriod itself thus removing it from all known Calendar catalogs. Bulk delete operations return the results in DeleteResponses .