Interface OffsetEventBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OffsetEventAdminSession, OsidSession, OsidSession
public interface OffsetEventBatchAdminSession extends OffsetEventAdminSession

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

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

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

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

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

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