Interface FamilyBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, FamilyAdminSession, OsidSession, OsidSession
public interface FamilyBatchAdminSession extends FamilyAdminSession

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

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

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

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

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

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