Interface LogBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, LogAdminSession, OsidSession, OsidSession
public interface LogBatchAdminSession extends LogAdminSession

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

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

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

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

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

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