Interface SettingBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, SettingAdminSession
public interface SettingBatchAdminSession extends SettingAdminSession

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

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

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

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

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

The delete operations delete Settings in bulk. To unmap a Setting from the current System , the SettingSystemAssignmentSession should be used. These delete operations attempt to remove the Setting itself thus removing it from all known System catalogs. Bulk delete operations return the results in DeleteSettings .