Interface TimePeriodBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, TimePeriodAdminSession
public interface TimePeriodBatchAdminSession extends TimePeriodAdminSession

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

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

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

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

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

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