Interface PublisherBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PublisherAdminSession
public interface PublisherBatchAdminSession extends PublisherAdminSession

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

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

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

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

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

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