Interface LogEntryBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, LogEntryAdminSession, OsidSession, OsidSession
public interface LogEntryBatchAdminSession extends LogEntryAdminSession

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

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

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

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

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

The delete operations delete LogEntries in bulk. To unmap a LogEntry from the current Log , the LogEntryLogAssignmentSession should be used. These delete operations attempt to remove the LogEntry itself thus removing it from all known Log catalogs. Bulk delete operations return the results in DeleteResponses .