Interface PollsBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PollsAdminSession
public interface PollsBatchAdminSession extends PollsAdminSession

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

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

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

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

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

The delete operations delete Polls in bulk. Bulk delete operations return the results in DeleteResponses .