Interface CalendarBatchAdminSession

All Superinterfaces:
AutoCloseable, CalendarAdminSession, Closeable, OsidSession, OsidSession
public interface CalendarBatchAdminSession extends CalendarAdminSession

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

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

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

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

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

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