Interface ConfigurationBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, ConfigurationAdminSession, OsidSession, OsidSession
public interface ConfigurationBatchAdminSession extends ConfigurationAdminSession

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

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

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

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

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

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