Interface RaceBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RaceAdminSession
public interface RaceBatchAdminSession extends RaceAdminSession

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

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

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

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

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

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