Interface ParameterBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ParameterAdminSession
public interface ParameterBatchAdminSession extends ParameterAdminSession

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

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

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

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

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

The delete operations delete Parameters in bulk. To unmap a Parameter from the current Configuration , the ParameterConfigurationAssignmentSession should be used. These delete operations attempt to remove the Parameter itself thus removing it from all known Configuration catalogs. Bulk delete operations return the results in DeleteResponses .