Interface ScheduleBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ScheduleAdminSession
public interface ScheduleBatchAdminSession extends ScheduleAdminSession

This session creates, updates, and deletes Schedules 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 Schedule , a ScheduleForm is requested using getScheduleFormsForCreate() specifying the desired schedule slot, time period, record Types or none if no record Types are needed. Each of the returned ScheduleForms 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 ScheduleForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ScheduleForm corresponds to an attempted transaction.

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

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

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

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

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