Interface SubscriptionBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, SubscriptionAdminSession
public interface SubscriptionBatchAdminSession extends SubscriptionAdminSession

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

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

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

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

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

The delete operations delete Subscriptions in bulk. To unmap a Subscription from the current Publisher , the SubscriptionPublisherAssignmentSession should be used. These delete operations attempt to remove the Subscription itself thus removing it from all known Publisher catalogs. Bulk delete operations return the results in DeleteResponses .