Interface EntryBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, EntryAdminSession, OsidSession, OsidSession
public interface EntryBatchAdminSession extends EntryAdminSession

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

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

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

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

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

The delete operations delete Entries in bulk. To unmap an Entry from the current Business , the EntryBusinessAssignmentSession should be used. These delete operations attempt to remove the Entry itself thus removing it from all known Business catalogs. Bulk delete operations return the results in DeleteResponses .