Interface ScheduleSlotBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ScheduleSlotAdminSession
public interface ScheduleSlotBatchAdminSession extends ScheduleSlotAdminSession

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

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

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

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

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

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