Interface RecurringEventBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RecurringEventAdminSession
public interface RecurringEventBatchAdminSession extends RecurringEventAdminSession

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

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

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

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

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

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