Interface FoundryBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, FoundryAdminSession, OsidSession, OsidSession
public interface FoundryBatchAdminSession extends FoundryAdminSession

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

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

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

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

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

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