Interface CyclicEventBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CyclicEventAdminSession, OsidSession, OsidSession
public interface CyclicEventBatchAdminSession extends CyclicEventAdminSession

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

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

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

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

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

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